BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / sb_117_2.zip / SDOC117B.ASC < prev next >

Wrap

Text File | 1993-01-29 | 292KB | 7,251 lines

Chapter 5. Menus ============================================================== 5.1 General information -------------------------------------------------------------- Just like QuickBBS and RemoteAccess is SuperBBS using a menu system that requires to be build up from scratch. (Although an easy installation program with some simple menus is included.) You will have to setup all menus and external screens. Super- BBS does include it's own menu program, which has all options available. It also supports 'unknown' menu options, so you can always use it. At this moment it is the only menu editor which supports the multi language options in SuperBBS. Any other menu program for QuickBBS is usable, as long as it supports 'unlisted' menu types, since SuperBBS has more menu options than QuickBBS has. There are several ways to setup a menu system for your BBS. The most used one looks like this: -------------------- Message menus | Main menu ------------------------- File menus | -------------------- Other menus Another method is to set up your menus by item: Main menu ------------------------- SuperBBS file & message | |------------------- Modem file & message | -------------------- Graphics file & message Either way, plan your menu structure carefully. Users like a menu structure which is easy to follow. Building a menu can be done in two ways. You can either build the whole menu with the menu editor, so text is displayed if needed, or you can start your menu with an ANSI/ASCII display option (with Hot-key) which will display the menu and have all the commands in the menu file. Both have advantages and disad- vantages. Using an ANSI/ASCII file as menu gives you the advantages that you can use more colours on one line, use graphics and even animation. Disadvantage is that all menu options will be visible to all callers, whatever securitylevel they have. You need to setup a display file option with a Crtl-A code, which means the command will be executed automatically. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 106 Using the normal menu has the advantages that you can hide several options from other security levels. Disadvantage is the limited use of colour per line. It will be up to you which way you choose. Be sure to check your menu files at every securitylevel you have set up. Strange things can happen if you make mistakes. Building a menu is simple, building a complex menu with many different options for different securitylevels is more diffi- cult. Take your time is a good advice. When building a menu, you will need to enter the following information: Text to display Text shown to user for this menu option. (Leave this empty if you use an ANSI/ASCII file to display the menu.) This line should contain a description and the char- acter to activate it. Optional data Optional data needed for the given menu type command. (See the menu commands.) Menu type Number of the menu type. (These will be listed below with a full description and the optional data needed.) Security Securitylevel needed to access this menu option. Key Key which activates this menu option. This can be any character on the keyboard. Foreground Colour in which the foreground of the text to display will appear. (Options: 0-15) Background Colour in which the background of the text to display will appear. (Options: 0-7) Flags A-D Flagsettings needed to access this menu option. Two special options are: Highlight colour The highlight colour is a colour which can be displayed on the text to display line through using a '^' in front and behind the text you want 'highlighted'. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 107 An example: Foreground colour: 2 Background colour: 0 Highlight colour...: 14 Text: This is a ^test^ for a menu. Result: This is a test for a menu. The word 'test' will appear in yellow, the rest of the line in dark green. Note that the special characters are not shown when displaying a menu. Prompt Line displayed below the menu options, prompting the user for an action. This line can have a different colour. Note that the supplied SuperBBS menu editor works a bit diffe- rent. But you still have to supply the above information. See the external utilities part of the documentation for infor- mation on the SuperBBS menu editor. These descriptions can differ from menu program to menu pro- gram, but the main idea stays the same. Use a menu editor which has an option for 'unknown' commands, since SuperBBS is expanding faster than the menu editors are, so you will be able to use the editor in the future. 5.2 Menu commands -------------------------------------------------------------- Now for the available menu commands. SuperBBS is pretty power- ful and has a lot of features, so read carefully. Make sure you take note of any optional data needed to set up a menu option. Without this data the menu option will not work or behave strangely. Used characters in the optional data fields: None = means no optional data needed xxxxxxx = means the data entered here is mandatory. <xxxxx> = means the data entered here is optional. The menu commands: Type.........: 0 Description..: Text line Display's the text you've entered in the menu editor for this command. No other action takes place. Optional data: None -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 108 | Type.........: 1 | Description..: Goto a new menu. | Will change the menu to the menu set up in the | optional data field. | Optional data: MenuName </F></M></D></NS></T></A> <Password> | If you want to protect your menu with a pass- | word, enter it behind the menu name, separated | with a space. Enter the menu name without the | .MNU extension. See for /F, /D and /M the part | in this documentation about 'menu templating'. | The /NS option will not send a CLS code before | displaying the menu. The /T option is used to | set opening hours on the menu option. You will | have to use it in this way: /T??:??-??:?? The | first ??:?? is the start time, the second ??:?? | is the closing time of the menu option both in | 24 hour format. When the menu option is closed, | a message will be displayed. The /A option is | used to set a minimum age for the menu option. | You will have to use it in this way: /A???, | where ??? is the age. If the user is too young, | a message is displayed. The password has to be | the last option on the line. | Type.........: 2 | Description..: Gosub to a new menu. | Same as option 1, with the difference that the | previous menu (the menu you left from) will be | added to the stack of menus you've visited. | This way you can follow the trail back through | your menus. | Optional data: MenuName </F></M></D></NS></T></A> <Password> | The same as for menu type 1. Type.........: 3 Description..: Return from last gosub. Return to the menu you last visited. This option only works if you use the type 2 menu option to get to a menu. Optional data: None or /NS You don't have to enter any menu name, since the stack contains the name of the menu visited last. This name is erased after the return, so you can use menu type 3 again to return to the before last used menu. The /NS option will not send a CLS code before entering the previous menu. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 109 | Type.........: 4 | Description..: Goto new menu and clear gosub stack | Clears the gosub stack used with menu options 2 | and 3. Then goes to the given menu in the | optional data field. | Optional data: MenuName </F></M></D></NS></T></A> <Password> | The same as for menu type 1 Type.........: 5 Description..: Display .ANS/.ASC file Display a textfile from the textfile directory setup in CONFIG.EXE and LCONFIG.EXE. SuperBBS first looks in the current language text direc- tory. If not found, SuperBBS will look in the directory specified in CONFIG.EXE. If a user has ANSI on, SuperBBS will first look for an ANS file, then for an ASC file. If the user has ANSI off, SuperBBS only looks for the ASC file. Optional data: FileName The filename to be displayed, without exten- sion. Type.........: 6 Description..: Selection menu Display a textfile which has up to 9 options available of other text files and display the Selection menu prompt, as set up in the CONFIG.EXE program. You will need to name all files the same, except for the last number. Suppose your main file is called BULLET.ANS then your other files will be called BULLET1.ANS to BULLET9.ANS. (If you have 9 files.) The main file is shown to the user. The user selects from the list displayed in the main file, which file he/she wants to read. If the user selects 3, the file BULLET3.ANS (or ASC) will be displayed. If the user selects 5, the file BULLET5.ANS will be displayed. After viewing the file, the user will be shown the main file again. Optional data: FileName This filename can be 7 characters or less. (Character 8 is reserved for the other textfile numbers.) The extension is always ANS or ASC and the files should be in your textfiles directory. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 110 Type.........: 7 Description..: Shell to DOS and run program This option is used for starting other pro- grams, like doorgames and mailscanners, in SuperBBS. It shells to DOS and starts the pro- gram given in the optional data field. SuperBBS will return to the menu the exit started from. Optional data: ProgramName <Parameters> This menu is one of the difficult menu options available, because of the large amount of para- meters. These are the parameters available: *B Caller's bps rate. This will be 0 if local, or 300 to 38400 if online. *C Full path to your COMMAND.COM file as set in the environment variable COMSPEC. (Con- sult your DOS manual for more information about COMSPEC.) This parameter is needed if you want to start a batchfile from this type 7 menu command. *E Read EXITINFO.BBS when returning to BBS. This can be handy if the program used with the type 7 exit, changes some of the user's data, like a timebank. *F User's firstname. *G Status of ANSI graphics. (0=Off, 1=On) *H Leave the Fossil driver (X00 or compatible) hot when exiting from SuperBBS. Some programs require this. (Most don't.) *I Path of current language file. *J User's screenlength *L User's lastname. *N Gives current node number. *P Gives current COM port number. *R User's recordnumber in the user database. *S Swap SuperBBS to EMS or disk. If you run a program which needs more memory than the normal amount available, specify the *S option, so SuperBBS will swap itself to EMS or, if EMS is not available, to disk. *T Time left this call. *U Path to current template file area. (See menu templating.) *X Template filename. SuperBBS now can pro- duce any kind of (ASCII style) exit file, supporting doors not made for SuperBBS. Create a template file with the extension .SBE and set it up as the door might need it. You have all control codes available. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 111 When you use the *X option in a type 7 exit, SuperBBS will replace the template given in the optional data field, like *XFilename.SBE, to create the exitfile Filename.EXT. Example: Exit template file: (TEST.SBE) ^FA ^FB ^KO ^KV Would give you an exitfile looking like this: (TEST.EXT) Aki Antman Helsinki, Finland 45 290 Being the full username, city, remaining time online and time of next event. Mostly you just use the *C and *S parameters. With multi-node operations, you will need the *N and *P options. Normally the documentation from the program you wish to run will supply the needed information. Type.........: 8 Description..: Version and copyright notice This option will show the user the version- number, copyright message and if your program is registered, the registration name of the SuperBBS version you're using. Optional data: None Type.........: 9 Description..: Logoff from the system This will disconnect the user from your system. Before disconnect, SuperBBS will show the user the GOODBYE.ANS (or ASC) file, if available. When using high speed modems, it might be needed to put a Ctrl-A at the end of the file, otherwise slow modems won't see much of the screen. Optional data: None -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 112 Type.........: 10 Description..: Display System Usage graph Show the user the system usage graph. This gives you the percentage use per hour. Optional data: None or /H If used with the /H option, SuperBBS will dis- play a horizontal graph, instead of the normal graph. Type.........: 11 Description..: Page the Sys(tem)Op(erator) for a chat See if the Sysop is available to talk to you. SuperBBS will ask the user for a reason for the chat. If the Sysop is not available, this rea- son will be stored in the SYSTEM.LOG file. Optional data: Prompt </FORCED> Enter the string, which will be shown to users who try to yell you. The /FORCED option will even start the yell outside yelling hours. Useful if you want your co-sysop or special users to call you even outside chat hours. Type.........: 12 Description..: Execute questionnaire file Execute the given questionnaire, for example NEWUSER.Q-A. The answers will be written in the same file name as the questionnaire, but the extension will be changed to .ASW. Optional data: FileName Extension of a questionnaire must be .Q-A or SuperBBS will not recognize the questionnaire. Answers will be written in the .ASW file. Type.........: 13 Description..: List/search user list Gives the option to search for a name in the userlist or display the whole list. Optional data: None, /S or /L If you specify no optional data, the list will contain no security levels. With the /S the securitylevels will be shown to the user. The /L option only shows the users with the same or lower security level. Type.........: 14 Description..: Time statistics Shows the user how long he/she has been on-line and how much time is left. Also gives the cur- rent date and time. Optional data: None -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 113 Type.........: 15 Description..: Exits to DOS with errorlevel Leaves SuperBBS and returns to the batchfile which you ran SuperBBS from. There you inter- cept the given errorlevel and start an external action. (For more information about error- levels, consult your DOS manual and see the batch examples in the appendixes of this man- ual.) If possible you should use a type 7 exit, instead of this type 15. Use the *S (and *E) when using a type 7. Optional data: Errorlevel <MenuName> The errorlevel will start the action required from your batchfile. (Don't use errorlevel below 10.) The optional MenuName tells SuperBBS to which menu it should return after ending the type 15 exit. You should restart the SuperBBS program with the -R option. (See Command Line Parameters.) Type.........: 16 Description..: Change City & State Allows the user to change his/her City and State. Optional data: None Type.........: 17 Description..: Change password Allows the user to change his/her Password. Optional data: None Type.........: 18 Description..: Change screenlength Allows the user to change his/her screenlength. Optional data: None Type.........: 19 Description..: Toggle screen clearing on/off Allows the user to toggle the sending of screen clear codes (CLS) on and off. Optional data: None Type.........: 20 Description..: Toggle the 'More (Y/n)' prompt on/off Allows the user to toggle the more prompt on and off. Optional data: None Type.........: 21 Description..: Toggle ANSI graphics on/off Allows the user to toggle the ANSI graphics on and off. Optional data: None -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 114 Type.........: 22 Description..: Scan for personal mail This option will scan the userbase and report any unread personal mail. Optional data: None </A> </G> The /A option tells SuperBBS to scan for new normal messages and for new group messages, while the /G option tells SuperBBS to only scan for new group messages. (See the chapter on the messagebase for more information on the group messages.) | Type.........: 23 | Description..: Read messages | Allows the user to read messages in the current | message area. If a message is private, it will | be skipped if it is not from you or to you. | Optional data: AreaNumber or /M </F></R></N></S></M></O> | Area number of the message base the messages | should be read from. If you use menu templa- | ting, this can also be the templating command | /M. See for details on the extra options the | chapter on changing hardcoded menu options. | (Chapter 5.4) | Type.........: 24 | Description..: Scan messages | Gives a list of messages with the header infor- | mation (who from, who to and subject) and gives | you the option to mark messages for later read- | ing. | Optional data: Areanumber or /M </F></R></N></S></M></O> | Area number of the message base the messages | should be scanned from. If you use menu templa- | ting, this can also be the templating command | /M. See for details on the extra options the | chapter on changing hardcoded menu options. | (Chapter 5.4) | Type.........: 25 | Description..: Quick scan messages | Gives a list like display of all messages in | the area with information about the sender, | receiver and subject. | Optional data: AreaNumber or /M </F></R></N></S></M></O> | Area number of the message base the messages | should be scanned from. If you use menu templa- | ting, this can also be the templating command | /M. See for details on the extra options the | chapter on changing hardcoded menu options. | (Chapter 5.4) -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 115 Type.........: 26 Description..: Delete messages Removes messages from the message base. This only works for messages from you or to you. (Unless you have Sysop access to this area.) Optional data: AreaNumber or /M Area number of the message base the messages should be deleted from. If you use menu templa- ting, this can also be the templating command /M. Type.........: 27 Description..: Write a message Allows the user to write a message. Optional data: <AreaNumber> </M> </L> </T=First_Lastname> Area number of the message base to write the message in or the menu templating command /M. If you leave this field blank, SuperBBS will use this menu option as an global write option and will ask the user in which area he/she wants to write the message. The /L will log the user off your system after saving the message (with displaying the file GOODBYE.A??). The /T=First_Lastname will send the message to the name given. Spaces should be set with the underscore character. The /L and /T option only works correct if you use an area number and NOT the /M command. You could use the /L and /T parameters for sending a message to the Sysop at logoff. | Type.........: 28 | Description..: Select combined message/QWK areas | Area 0 is a special message area. You can't | write a message in this area, but you can read | messages from all areas connected in numerical | order. This option allows the user to select | the areas he/she wants to use in his/her com- | bined board. You can select standard areas or | exclude areas from the combined board in the | CONFIG.EXE program, the Message base part. | This option is also used to select areas for | the QWK mailreader system. Only areas selected | will be used in the QWK mail search. | Optional data: None -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 116 Type.........: 29 Description..: Move a file Normally spoken an option only available to the Sysop. It will allow you to move a file from one area to another. It also moves the descrip- tion in the FILES.BBS file. Optional data: FullPath or /F You need to give the full directory path from where the file will be moved or the /F if you use menu templating. Type.........: 30 Description..: MS-Dos directory Like a normal DIR command, will SuperBBS dis- play the given directory. Optional data: FullPath or /F Give the full directory path or the /F. | Type.........: 31 | Description..: List FILES.BBS | The normal way to show a user what's available | in the given directory. It will show the | filename, date, size and description. For CD- | Rom users is an option build in to have the | FILES.BBS file in a different location then the | files itself are. See the CONFIG.EXE program, | the File area editor. | SuperBBS will ask the user for a file mask to | display. There is also an option to only dis- | play the newfiles. this is done by entering /N | at the filemask question. | Optional data: FullPath or /F </N> | Supply the directory or the /F command. CD-Rom | users should use the /F command. The /N option | will only display the new files in that direc- | tory. Type.........: 32 Description..: Download a file This option will send a file from the BBS to the user. Optional data: None <FullPath> </F> <PassWord> If you leave the optional data field empty, SuperBBS will use this command as a global download command. It will search in every area the user has access to, trying to find the requested file. Use the full path or the /F option and SuperBBS will only look in the cur- rent area. The FullPath and /F option allow the use of a password, which need to be given before the download will be started. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 117 Please note that the <*> option is no longer supported. This is replaced with an option in the FILES.CTL file. Please delete the * from your optional data fields, otherwise SuperBBS will ask for a password before downloading. Type.........: 33 Description..: Upload a file This option will receive a file which the user sends to the BBS. Optional data: FullPath or /F Supply the full directory or the /F option. By using the full directory command, it is poss- ible to receive all uploads in one directory. The /F will place the file in the current area. Type.........: 34 Description..: View an archived file Shows what the archive file contains. It sup- ports ZIP, LZH, ARJ, PAK and ARC files. Optional data: FullPath or /F Supply the full directory path or the /F option. Type.........: 35 Description..: Search for file by Keyword Look for a word in the FILES.BBS files. Optional data: None Type.........: 36 Description..: Search for file by Filename Look for a file in the FILES.BBS files. Wild- cards are allowed as search options. Optional data: None Type.........: 37 Description..: List new files on system Shows the new files since the last login or the given date. It is also possible to use the new files check since last time viewed. This means that SuperBBS will remember when the user last viewed the new files and will set the date to scan from to that specific date. This option can be configured in the main configuration program. When enabled, this option also works on the new files scan at logon. Optional data: None -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 118 Type.........: 38 Description..: Type a textfile Allows the users to read a textfile on-line from your FILES.BBS list. (If there is a text- file in there.) Optional data: FullPath or /F Supply full directory path or the /F option. Type.........: 39 Description..: Display a textfile Show the user a textfile. This option is like menu option 5, except you have to supply the fullpath and filename. This allows you to show any file you want. No 'Press Return' is given at the end of the file. Optional data: Fullpath and FileName Supply the full path and filename to the text- file. Including the extension! Type.........: 40 Description..: Display ANS/ASC file with Hotkey Show the user an ANSI or ASCI file, but keep the hot keys active. This can be used to dis- play a menu file. If you use this command to show the file, the user doesn't have to wait till the whole screen is drawn, but can make his choice at once. With a type 5 menu, the hot keys are not active during the display of the file. This command is mostly used in combina- tion with a Crtl-A command in your menu. (Crtl- A = Automatic execution) Optional data: FileName Supply the filename to be shown. Don't give an extension, as SuperBBS will always look for a ANS or ASC extension. The file has to be in the textfile directory. Type.........: 41 Description..: Toggle Full Screen editor on/off If you have a full screen editor installed, like Quicked, you can allow your users to toggle the editor on and off with this option. If it is off, the build in editor will be used. Optional data: None Type.........: 42 Description..: RESERVED - Do not use Type.........: 43 Description..: RESERVED - Do not use Type.........: 44 Description..: RESERVED - Do not use -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 119 Type.........: 45 Description..: Display ANS/ASC file with 'Press ENTER' The same as menu type 5, except that SuperBBS will put a 'Press ENTER to continue' prompt after it showed the file. This will pause the screen till a reaction from the user is received. Optional data: FileName or fullpath and filename Supply the filename, without extension. The file has to be in the textfile directory. If you supply the filename and path, you can dis- play any file and have the 'Press Enter' at the end. Type.........: 46 Description..: Show GIF pictures resolution Show the resolution of the GIF picture (only of if it is stored on you disk as a .GIF file), which name is supplied by the user. This option doesn't look in archives! Optional data: FullPath or /F Supply the full directory path or use the /F option. Type.........: 47 Description..: Write entry to System log Write the text, given in the optional data field, to the SYSTEM.LOG file. This is handy if you want to know if a menu option is used or for any other information. Optional data: Text to be written The text given in this field will be written to the system logfile. Type.........: 48 Description..: Download a specific file By using this option, you only ask the user which download protocol he/she wants to use and then starts the download. You supplied the filename in the optional data field. This can be used to download your ALLFILES list. Optional data: FullPath+FileName Supply the file the users can download through the use of this option. Type.........: 49 Description..: RESERVED - Do not use Type.........: 50 Description..: RESERVED - Do not use Type.........: 51 Description..: RESERVED - Do not use -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 120 Type.........: 52 Description..: RESERVED - Do not use Type.........: 53 Description..: Toggle mailcheck at logon on/off Allows the user to toggle the mailcheck at logon on and off. Optional data: None Type.........: 54 Description..: Toggle newfiles check at logon on/off Allows the user to toggle the newfiles check at logon on or off. Optional data: None Type.........: 55 Description..: Show BBS list (Short) Shows the user the build in BBS list in the short version. Optional data: None Type.........: 56 Description..: Add BBS to BBS list Allows Sysops to add their BBS to your BBS list. Information like telephone number, name, on-line hours, software and Sysop name are stored. Optional data: None Type.........: 57 Description..: Leave comment to next user A comment of 2 lines can be left behind for the next user. This will be shown to the next caller at logon. The user will not be logged off after entering the comment. Optional data: None Type.........: 58 Description..: Show callers Gives a list of the last 15 callers with the time they came on-line and went off-line. Also shown are bps rates and age. Optional data: None or /T If no optional data is specified the list will display the last 15 callers of all available lines. With the /T option, the list will con- tain all callers since midnight. Please note that the filename for this option has changed in v1.16. The file used is now called SCALLERS.BBS and the old file SLCALLER.BBS is no longer used and can be deleted. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 121 Type.........: 59 Description..: Change colour configuration Allows the user to change the colour configur- ation of the BBS. This is the same as in the CONFIG.EXE program, but only works for the current user, while the CONFIG.EXE part, works for every user. Optional data: None Type.........: 60 Description..: Extract files Allows the user to extract a file, then after- wards he/she can view the files inside the archive and repack (some) files. All from with- in SuperBBS. Optional data: None <FullPath> </F> If you leave the optional data line empty, it means extract the file which is IN the TEMP directory. This TEMP directory is setup in the CONFIG.EXE program. If you enter the full directory path or the /F, for menu templating, this menu type will react as extract TO the TEMP directory. Note the difference! Type.........: 61 Description..: Archive files The user will be asked which files have to be archived. This option is to be used with the extract option, menu type 60. Optional data: FullPath or /F If you enter the full directory path of the TEMP dir, the files will be packed from that area. If you use the /F or the full directory path to your file areas, the requested files from that area will be packed. Type.........: 62 Description..: Delete files The user will be asked which files have to be deleted. This option is to be used with the extract option, menu type 60. Optional data: FullPath or /F If you enter the full directory path of the TEMP dir, the files will be deleted from that area. If you use the /F or the full directory path to your file areas, the requested files from that area will be deleted. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 122 Type.........: 63 Description..: Show BBS list (Long) Show the user the long version of the BBS list. The user has the option to enter the name he/she wants to look for. All available data about the BBS will be shown. Optional data: None Type.........: 64 Description..: Change BBS information in BBS list Allows Sysops to change their BBS data in the BBS list. Only you and the person named as Sysop in the BBS list is able to do this. Optional data: None Type.........: 65 Description..: Delete BBS information from BBS list Allows Sysop to remove their data from the BBS list. Only you and the person named as Sysop in the BBS list is able to do this. Optional data: None Type.........: 66 Description..: Download BBS list Allows users to download the BBS list. Only the protocol will be asked for. Optional data: None Type.........: 67 Description..: Change user's phone number(s) Allows the user to change his/her phone num- ber(s). Optional data: None, /V or /D The /V for Voice and the /D for Data numbers can be used if you don't want SuperBBS to ask the user for both telephone numbers. /V will only ask for the voice number and /D will only ask for the data phone number. Type.........: 68 Description..: Select message area from arealist Allows the user to change area with the build in area change command. This will display a two row list of all the available (to this user) message areas. Use this for changing areas when using menu templating. Optional data: None, /3, /N or /G=? When no option is given, SuperBBS will show all mail areas to the user to which he/she has access. When the /G option is used in conjunc- tion with a message group character, SuperBBS will only show the mail areas belonging to that > Continued > -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 123 group. For example /G=L will only show the areas belonging to mailgroup L (as specified in the area setup). The /N option will ask directly for the area- number, without showing the area list first. Users who know which area they want will bene- fit from the speed. Users who don't know which area they want can just press ENTER and Super- BBS will show the arealist. The /3 option will show the arealist as it was in SuperBBS before version 1.16. (Version 1.16 and up uses a standard 2 collum display.) You will get three collum of areas with the /3 option. Please note that areanames should not exceed 20 characters when using this option. There is also an option to use an ANS/ASC file for displaying the areanames. See for more information the MSGAREA.A?? file. If this file is found, SuperBBS will use this textfile instead of the build in arealist. Type.........: 69 Description..: Select file area from arealist Allows users to change area with the build in area change command. This will display a one row list of all the available (to this user) file areas. Use this for changing areas when using menu templating. Optional data: None, /P or /2 If you use the /P, the change area command will change into a pick area command for ANSI users only. The user can select an area from the list with the cursor control keys. Local users should use the cursor control keys on the numeric keyboard with NUMLOCK on. (The other cursor keys are used to change the online time). The /2 command will give you two rows instead of the one single row when no optional data is given. With this option, your area names have to be shorter than 30 characters, but it allows you to display twice as much areas on screen at once. Type.........: 70 Description..: Change alias Allows the user to change his/her alias. Only works if you allowed the use of an alias on your system. Optional data: None -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 124 Type.........: 71 Description..: List aliases Shows an user - alias list of all users. The user is given the option to select a search criterium. Optional data: None Type.........: 72 Description..: Show user's balance in the timebank Allows the user to see how much time he/she has deposit in the timebank. You can set a maximum in the CONFIG.EXE program. Optional data: None Type.........: 73 Description..: Deposit time in timebank Allows the user to store time in the timebank. Optional data: None Type.........: 74 Description..: Withdraw time from timebank Allows the user to withdraw time from his/her account. Optional data: None Type.........: 75 Description..: User online / Other line status Show's who is on the other line(s) or the cur- rent status of the other line(s). Optional data: None </S> If you leave the optional data field empty, SuperBBS will show the user who is on the other line(s). If you use the /S parameter, SuperBBS will show you the status of the other line(s). Type.........: 76 Description..: Send message to other user on-line Allows the user on a line to send a on-line message to a user on another line. This only works if the 'Do not disturb' flag is not on. Optional data: None Type.........: 77 Description..: Change current language Allows the user to change his/her current lan- guage file. (If you run with more than one language file.) Optional data: None -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 125 Type.........: 78 Description..: Toggle 'Do not disturb' on/off Allows the user to toggle the 'Do not disturb' flag on and off. This way he/she can prevent receiving messages from other line users. Optional data: None Type.........: 79 Description..: Toggle full-screen message viewer on/off Allows the user to toggle in SuperBBS the full- screen message reader on or off. Quotes are now written in a different colour when messages are viewed with the fullscreen message viewer. Optional data: None Type.........: 80 Description..: Displays mail areas with unread mail. All areas which contains mail not yet read by the user will be displayed. The menu option also tells the user how many messages are unread and if there are any personal unread messages. Optional data: None or /C The /C option works on the user selected com- bined boards (Message board 0). If you leave the optional data field empty, it works on all message areas. Type.........: 81 Description..: This menu option allows the user to scan a file for a virus infection. SuperBBS normally scans uploads for viruses (if enabled), but now the user can enter a filename of the file he/she wants to scan. You will need the known ar- chivers and the SCAN virusscanner somewhere in your path. Optional data: /F or Full path Type.........: 82 Description..: Allows the user to download the messages in the QWK format, so he/she is able to read them offline at his/her own pace. Optional data: None Type.........: 83 Description..: Upload option for replies on the QWK messages downloaded with the menu option 82. The upload is done in a .REP file, which SuperBBS will extract and than place the messages contained in the .REP file in the correct areas, or the default QWK area. Optional data: None -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 126 Type.........: 84 Description..: Allows the user to update his/her lastread pointer, telling SuperBBS where to start searching for new messages when downloading a QWK packet. Optional data: None Type.........: 85 Description..: Show an aphorism to the user. An aphorism, also called 'fortune cookie' is a little text which is funny or interesting or just a text. (Like the laws of Murphy.) SuperBBS will randomly display an aphorism from a file given in the optional data field. This file has to be in a certain format: ** Life is great if you run SuperBBS! By: Frank Hemmelder ** SuperBBS is now bugfree! By Aki Antman SYSTEM ERROR: Disconnecting ** The ** has to be the first two characters on the line. They separate the aphorisms from each other. The ANSI/ASCII file APHORISM.A?? is displayed before the aphorism itself. You can use all control codes in the aphorism file, like all colour codes and other options. Optional data: Drive:\Fullpath\Filename.ext (and /N) The /N will suppress the 'press ENTER' line after the aphorism is shown. Type.........: 86 Description..: Execute the doornumber in the optional data field or the current door in the configuration program. Optional data: Doornumber or /D When using the door template menu, use the /D option to execute the door. When you want to start a specific door, use the doornumber as setup in the configuration menu. SuperBBS will save the door information, so the user will be returned to the same door the next time he chooses the door menu. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 127 Type.........: 87 Description..: Select a door from the list. Use this command when working with the door template menu as set in the configuration. This option will display a list of all available (to the user) doors. If his/her security is too low, or the user doesn't have the correct flagsetting for a door, this door won't be displayed in the list. Optional data: None or /R The /R option will execute the selected door automatically. this option is useful for pro- grams which do not need a menu, but can be run at once. Without the /R option, SuperBBS will change to the template menu for the selected door. | Type.........: 88 | Description..: Browse the nodelist menu option. this allows | you and your users to search through the node- | lists, when compiled, for a certain address. | You will have to compile the nodelist with the | SBBSNODE.EXE program. (See the chapter on util- | ities.) This is the format when viewing: | | Z:? = Display list of zones | 2:? = Display nets in zone 2 | 2:220/? = Display nodes in zone 2 net 220 | | Optional data: None Type.........: 89 Description..: This menu command is an area by area read com- mand. You can read all unread messages in all areas on behind each other. If there are no new messages, SuperBBS will search for the next area with new messages. You can always stop reading after a message by pressing the corre- sponding key for the Stop command. There is also a command available to go to the next area. Optional data: None Type.........: 90 Description..: Attach a file to another user. This way a user can send a file to another user. If local, the file will be copied to the correct place, after SuperBBS prompts for the filename. When used remote, the user can upload the file by using any protocol. This menu option allows the transfer of the files privately. SuperBBS will store the files in the Local Attach area, set in the configuration program. (The LA directory in the directory configuration.) > Continued > -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 128 Optional data: None or message area number When using the optional message area number, the user can leave a message to the receiver of the file, telling him/her about the file. If no optional area number is used, there is no mess- age attach option for the user. Type.........: 91 Description..: Check if the current user has some attached files waiting. If there are files waiting, the user will be told so and given the option to download them. You can enable/disable the check on local attach files from the configuration program. Optional data: None Type.........: 92 Description..: Select the archiver the user wants to use to archive the .QWK packet with. Used with menu option 82 and 83. Optional data: None | Type.........: 93 | Description..: Sysop download function. This function allows | you to download a file from anywhere on the | system(s). Passwords set in the FILES.CTL file | are needed to download the password protected | files. Use this option with care. | Optional data: None Type.........: 94 Description..: Show users age graph. It will generate a graph of all the users ages. Optional data: None or /S=? When no optional data is given, SuperBBS will start the graph at the age specified in the configuration program. If the /S=? is used, you can select at which age to start the graph, by changing the parameter. For example /S=34 will start the agegraph at the age of 34. Type.........: 95 Description..: This menu command is used to either remove files from the list of flagged files and to show the flagged files in listform. Optional data: /S or None When used with no optional data, this command means remove a file from the flagged files list. With the /S command it means that Super- BBS will show the flagged files. Note the dif- ference. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 129 Type.........: 98 Description..: Toggle hotkeys on or off. Use this command to allow your users to toggle the hotkey, that is pressing a menu key will give a reaction with- out having to press ENTER or no hotkeys, which means you have to press ENTER after each com- mand. Optional data: None Type.........: 99 Description..: Chat between nodes. See also menu type 100 on how to start a nodechat. Optional data: None Type.........: 100 Description..: Create a conference for group chats. When a user wants to use groupchat, he/she has to create a (temporary) conference, which other users can join. When the last user exits from the conference, the conference is deleted. (Only persons with Sysop level are able to make conferences which are not deleted when the last user logs off from the conference.) You should have at least one permanent conference. Optional data: None or /D When no optional data is given, a conference is generated. When the /D option is given, a con- ference can be deleted. (Except for permanent conferences, which can only be deleted by people with Sysop access.) | Type.........: 101 | Description..: Leave a message comment which is shown to the | user writing a message to you when entering a | message in a local message area. This allows | your users to post a notice to other people | writing messages to them. The notice is dis- | played before the user starts writing the mess- | age. Note that the comment will be shown when | writing messages to the person who left the | note in all local message areas. | Optional data: None or /R | When no optional data is specified, SuperBBS | will ask the user to leave a comment. With the | /R option filled in, it means remove the com- | ment from SuperBBS. That's it, all available menu commands. If you are convert- ing from RemoteAccess, Proboard or QuickBBS to SuperBBS, remember that there are different options available in Super- BBS, which the others do not have. Please check your configur- ation carefully if starting with SuperBBS. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 130 5.3 Menu templating -------------------------------------------------------------- Maybe you remember the good old days. In those days you had to build a menu for every available message and file area. Those days are gone. Now there is menu templating. This means you have one menu for all your message areas, another for all your file areas and another for your doors. How does it work? First you design your menu. Then you enter all the needed information. But instead of entering messagebase numbers, you enter /M. SuperBBS will replace this with a message area number. The same for the file areas. Design your menu, enter the /F instead of the directory. SuperBBS will replace it with the information given in the CONFIG.BBS program. When design- ing your menu for doors, use the /D option, instead of the doorname. Let's have a look at how to setup a message menu this way: First you have to get from your main menu to the message menu. We want to start in area 01. We use menu option 1 and the optional data field would be: MAIL /M. MAIL is the menu name, /M tells SuperBBS to go to the message area last visited by the user. If he/she never visited a the mail areas, he/she will be placed in the first area defined in CONFIG.EXE. If you want to go to the second area, you could also have said /M=2. Now we need the read, write, scan, quickscan and delete options. Set up the menu as you normally would, except instead of using the messagebase number, use the /M in the optional data field. SuperBBS will know in what area the user is. Even if the user goes to the main menu and then returns to the messagebase, he/she will still be in the area he/she left from, because SuperBBS keeps track of the users movement. You can use the /M (/F for fileareas and /D for doors) for changing the area. If you use a type 1 menu and as optional data field the menu name and /M=+1, SuperBBS will change to the next area. If you use in the optional data field the /M=-1, SuperBBS will change area to the previous area. This option is endless, because the user is placed back to the first area when he/she wants to go to the next area from the last area. It looks like this: ---> 1 --> 2 --> 3 --> 4 --> 5 --> 6 --> 7 --- | | ---------------------------------------------- In this example is area 1 the lowest and area 7 the highest. This also works the other way around. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 131 So in short: Menu type 1 - MenuName /M = Goto message area Menu type 2 - MenuName /F=31 = Gosub file area 31 Menu type 23 - /M = Read messages in current area Menu type 32 - /F = Download from current area Menu type 1 - MenuName /M=+1 = Goto next message area Menu type 1 - Menuname /F=-1 = Goto previous file area Menu type 1 - MenuName /D = Goto door menu Menu type 1 - MenuName /D=+1 = Goto next door menu Menu type 86 - /D = Run current door To show the name and number of the area you are currently in use these codes: <Ctrl-K>4 = File area name in ANS/ASC files <Ctrl-K>5 = Message area name in ANS/ASC files <Ctrl-K>" = Number of current message template area <Ctrl-K># = Number of current file template area <Ctrl-K>& = Name of current door <Ctrl-K>/ = Number of current door @ (Ascii 64) = File area name in menu textline ' (Ascii 96) = Message area name in menu textline These codes are replaced with the name you have set up in the CONFIG.EXE program. If you use characters behind these codes, please think about the fact that the codes will be replaced by the area name, so you might have to check if your menu is still aligned the way you want it. Example: In your menu: Area ^K#: @ SuperBBS HQ For the user: Area 12: General area SuperBBS HQ In this example the user is in file area 12, General area. Note that the control code should be entered by holding down the Control key and pressing the K key. The # is a normal character which should be entered without the control key being pressed. SuperBBS saves the template information, so the user will be put in the same template menu he/she was last in when calling the next time. 5.4 Changing hardcoded menu options -------------------------------------------------------------- SuperBBS has the option to allow the use of your own commands, instead of the hardcoded menus in SuperBBS. These options can be used for these menu commands: 23 Read messages 24 Scan messages 25 Quickscan messages -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 132 These are the available commands to replace the hardcoded box in SuperBBS. You need to set these options in the optional data field, when editing a menu. /F Read messages in forward order /R Read messages in reverse order /I Read individual messages /N Read new messages /S Read selected messages /M Read marked messages /O Read n number of messages These options are also available in template menus, so you're able to build a very powerful (and in your own language if needed) message menu. Here is an example of a menu. The first /M is from the message area the second '/' option is to replace the hardcoded menu. Menu Opt. data Menu textline ---- -------- ---------------------------------------------- 23 /M /F Read messages in forward order in current area 23 /M /M Read marked messages in current area 24 8 /S Read selected messages in area 8 25 /M /N Quickscan new messages in current area 27 /M Write a new message in current area 68 Choose other area from area list And your imagination can do the rest. It is just an example, so don't use it as a complete menu! 5.5 INCLUDE1.MNU -------------------------------------------------------------- This is a very special menu file. This menu allows up to 10 commands to be entered, which then will be added to all your existing menus. If SuperBBS finds this file in your menu directory, all menu commands are available to the user at any menu in your BBS. Very useful for the logoff command, paging the Sysop, help and what you can think of. Design the menu as you normally would design a menu. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 133 Chapter 6 Control codes ============================================================== 6.1 Control codes in menu and textfiles -------------------------------------------------------------- You can now use several control codes in your menu. They don't have to be displayed through an ANSI or ASCII file, but can be used on the menu textline itself. Here's a complete list of all the control codes you can use, either in an ANSI or ASCII file or in your menu textline: (^ = Ctrl key) ASCII Char. Function description --------- -------- ----------------------------------------- 1 ^A Wait for ENTER key to be pressed 2 ^B Turns OFF aborting with S key 3 ^C Turns ON aborting with S key 4 ^D Turns ON the 'More' prompt 5 ^E Turns OFF the 'More' prompt 6 ^F Not used alone (See below) 7 ^G Generates a 'BEEP' 8 ^H Backspace 9 ^I Tabulator 10 ^J Linefeed 11 ^K Not used alone (See below) 12 ^L Clears screen 13 ^M Carriage return 6.2 ^F codes -------------------------------------------------------------- The ^F codes available: (All codes apply to current user!) ASCII Char. Function description --------- -------- ----------------------------------------- 6 65 ^FA User's full name 6 66 ^FB User's city and state 6 67 ^FC User's password (Use with care!) 6 68 ^FD User's business/data phone number 6 69 ^FE User's home/voice phone number 6 70 ^FF User's last calling date 6 71 ^FG User's last calling time (24 hrs format) 6 72 ^FH User's A flagsetting 6 73 ^FI User's B flagsetting 6 74 ^FJ User's C flagsetting 6 75 ^FK User's D flagsetting 6 76 ^FL User's netmail credit 6 77 ^FM Number of messages user has written 6 78 ^FN Highest message number user has read 6 79 ^FO User's security level 6 80 ^FP User's number of calls -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 134 6 81 ^FQ User's uploads in files 6 82 ^FR User's uploads in KBytes 6 83 ^FS User's downloads in files 6 84 ^FT User's downloads in KBytes 6 85 ^FU Elapsed time this call in minutes 6 86 ^FV User's screen length 6 87 ^FW User's firstname 6 88 ^FX Status ANSI graphics (ON/OFF) 6 89 ^FY Status More prompt (ON/OFF) 6 90 ^FZ Status CLS codes (ON/OFF) 6 48 ^F0 User's Sysop comment 6 49 ^F1 Status Full Screen editor (ON/OFF) 6 50 ^F2 User's age 6 51 ^F3 User's birthday 6 52 ^F4 User's time of first call (24 hrs format) 6 53 ^F5 User's date of first call 6 54 ^F6 Status of mailcheck at logon (ON/OFF) 6 55 ^F7 User's up/download ratio in KBytes 6 56 ^F8 User's up/download ratio in files 6 57 ^F9 Status new files check at logon (ON/OFF) 6 33 ^F! Total minutes used 6 34 ^F" Status full screen reader 6 35 ^F# Expiration date 6 36 ^F$ Expiration days left 6 37 ^F% Status of combined mail check 6 38 ^F& User's default protocol 6 47 ^F/ Status of Hotkeys (ON/OFF) 6.3 ^K codes -------------------------------------------------------------- The ^K codes available: ASCII Char. Function description --------- -------- ----------------------------------------- 11 65 ^KA Total number of calls to system 11 66 ^KB Name of the last caller 11 67 ^KC Number of active messages on system 11 68 ^KD Number of lowest message on system 11 69 ^KE Number of highest message on system 11 70 ^KF Number of times user has yelled SysOp 11 71 ^KG Day of the week in full 11 72 ^KH Number of users on system 11 73 ^KI Current time (24 hrs format) 11 74 ^KJ Current date (DD-MM-YY) 11 75 ^KK Number of minutes connected this call 11 76 ^KL Number of seconds connected this call 11 77 ^KM Number of minutes used against time limit 11 78 ^KN Number of seconds used against time limit 11 79 ^KO Number of minutes remaining this call 11 80 ^KP Number of seconds remaining this call 11 81 ^KQ Time Limit this call (Minutes) 11 82 ^KR User's baud rate (300-38400) -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 135 11 83 ^KS Abbreviated day of week 11 84 ^KT Download Limit in KBytes 11 85 ^KU Number of minutes until next system event 11 86 ^KV Time of next system event (24 hrs format) 11 89 ^KY User's maximum up/download ratio in KBytes 11 90 ^KZ User's maximum up/download ratio in files 11 48 ^K0 Current language file description 11 49 ^K1 Status of scroll lock 11 50 ^K2 One second pause 11 51 ^K3 Display securitylevel comment (LIMITS.BBS) 11 52 ^K4 Name of the current filearea 11 53 ^K5 Name of the current message area 11 54 ^K6 User's alias 11 55 ^K7 User's time in bank 11 56 ^K8 User's number of calls today 11 57 ^K9 Number of messages in current area 11 33 ^K! Status of do not disturb flag (ON/OFF) 11 46 ^K. Number of current node 11 34 ^K" Number of current message template area 11 35 ^K# Number of current file template area 11 37 ^K% User's download remaining today in KBytes 11 38 ^K& Name of the current door 11 47 ^K/ Number of the current door | 11 ^K- Number of flagged files | 11 ^K? Size in KB of flagged files. Do not use the ^Q, ^S and ^Z commands, because these are dangerous and can give you unexpected problems. To enter a code in your textfiles, use the Ctrl-F command. This means, press the control key, hold down while pressing the mentioned key (in this example the F), release and press the second character (in case of the ^F and ^K keys.) Another way is holding down the ALT key and pressing the ASCII value from the numeric keypad on the right of the keyboard. This only works on EXTENDED keyboards!! 6.4 ^X, ^C, ^P and ^A keys -------------------------------------------------------------- There are four special control keys available. These have special functions in SuperBBS or the external utilities. The ^X key is used to run a program from an ANSI or ASCII file. If superBBS comes across an ^X code while displaying a file, it will execute the program behind the ^X code. For an example: ^XMYPROG.EXE This will start the MYPROG.EXE program when the file is dis- played where this code is in. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 136 The ^C, ^P and ^A key are used in the LCONFIG program and menu editor. The ^C code is used for changing colour in the text- lines in LCONFIG.EXE. (See the language configuration part of the docs for more info.) The ^A executes a display of a file in the language files. You can use this command to display an ANSI/ASCII file, instead of the normal textline. ^AHELP will display the file HELP.A?? from the textfile directory. The ^P key is used to enter another control code in the menu and/or textlines. You have to press ^P first, before you can enter a control code in a textline or menuline. 6.5 ^O control codes -------------------------------------------------------------- With the release of the 1.15 version of SuperBBS, a new set of control codes have been added to the program. These codes are accessed through the ^O key. You can use the ^O key to display the flagsettings of the user. Here's the commandline: ^O<Flag><Flag number> This will display the current user's flagsetting, either On or Off. For example ^OA5 will display the setting of flag A, number 5. With this option you can display all 32 flags. 6.6 Additional control codes -------------------------------------------------------------- Some additional control keys can be used within the message- base from SuperBBS. These codes are: @1 User's name @2 User's City & State @3 User's security level @4 User's birthday @5 User's age @6 User's firstname These codes can be used, if you did allow them to be used in CONFIG.EXE, in messages written in SuperBBS. The following additional control keys are needed for setting up a multiline system with template menus. These codes can be used in the data fields of the menus. The codes are: @N Number of the node the user is on @M Number of current message template area @F Number of current file template area @G Character of current message area group @S User's security level @D Number of the current template door -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 137 These codes allow you to use the temporarily areas in a multi- line system. For example, name your temporarily directories TEMP1 and TEMP2, for line 1 and 2, and specify the optional data field with TEMP@N, which will be replaced by TEMP1 or TEMP2 depending on the node the user is on. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 138 Chapter 7. Message base ============================================================== 7.1 General information -------------------------------------------------------------- The SuperBBS message base is fully compatible with QuickBBS and RemoteAccess. This will not guarantee that this will stay this way in the future. Either SuperBBS or the other programs might come up with a better type of message base. Currently you can use your old messagebase when converting from RA and QuickBBS to SuperBBS. You should set up the location of your messagebase in the CONFIG.EXE program. User's (and Sysop) are able to read, write, scan, quickscan and delete messages. The messages are numbered in increasing order. The first message starts at one, the second at two and so on. This doesn't mean both messages are in the same area. Besides the message number, SuperBBS also keeps track in which area the message belongs. When reading messages, you will see a notice stating that there are xxxx messages active. And that the lowest message is numbered yyyy and the highest zzzz. Also stated is the amount of messages in the current area. It looks something like this: Active msgs: 1234. Lowest message: 1. Highest message: 23460 Number of messages in this area: 25. This means that from the 1234 messages, which starts at 1 and ends at 23460, there are 25 messages in the current area. SuperBBS now also supports real message numbering in an area. Every message area will be numbered from 1 to xx. This only applies to the user reading mail. Internally SuperBBS still uses the normal message numbering as described above. If you use this option of real message numbering, which we strongly suggest cause it is easier for your users to keep track of numbers while reading messages, you will have to change a line in the language file. This is the line stating the amount of messages in the messagebase. This has to be changed to the amount of messages per area. See the Lconfig part for more information. As of version 1.16, SuperBBS uses a new file to store the message areas in. This file is called BOARDS.BBS. You can have one file for all nodes, or have a file for every node. This way you can allow access to certain areas on certain lines. You can set this option in the configuration program (Path options). There is a little utility program to convert the information from the BOARDS.BBS file to the CONFIG.BBS file, so that external, non SuperBBS, programs can still be used. This utility is called BOARD2CF.EXE. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 139 | Maximum number of areas is 200. Maximum number of messages in | the messagebase is somewhere around 14000, although some | echomail processors have a 12000 message limit. | | When using the combined message area (area 0) there are some | new options available to change the selected areas. You can | now also specify 1-35 ON to select area 1 to 35. Or 34-40 OFF | to deselect area 34 to 40. Any message number can be used | here. 7.2 Sysop keys available -------------------------------------------------------------- The following options are available to the Sysop when reading messages: <A>gain Show current message again. <N>ext Show next message ack Show previous message <J>ump Jump to specified message <R>eply Reply to the current message <W>rite Write a message in current area <D>elete Remove the current message <K>eep as unread Toggle the read/unread flag on/off <X>port Send message to printer or file <C>opy Copy current message to another user/board | <E>dit Edit the message information, like: | 1. From Who wrote the message | 2. To To whom message is send | 3. Subject Subject of the message | 4. Board Area number where msg is | 5. Quit Abort editing | 6. Edit text Edit the already saved text | 7. Save Save message <=>Private Toggle the private/public flag on/off <S>top Stop reading messages | pdate Allows you to edit the senders user's in- | formation. You can use SBBSUSER.EXE or the | normal update procedure. Note that the | SBBSUSER.EXE option will only work while | in local mode. Note that SBBSUSER.EXE must | be found in your path to work properly. Use the <E>dit command and option 4 if you want to copy a message to another area. Use the <C>opy command if you want to forward a message to another user or system. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 140 | Use the <E>dit command and option 6 when you want to edit the | text in an already saved document. You can use the fullscreen | editor, the suggested way, or use the line editor. Please note | that not all fullscreen editors are capable of loading the old | message directly into the editor. If your editor cannot read | the message automatticaly, you will have to quote it back into | the editor. Gedit, the fullscreen editor, is capable of load- | ing the message in directly. | | When copying messages, it is now possible to edit the message | using the fullscreen editor. One undocumented option is available to Sysops when reading ECHO and NET mail, the <!>. This allows you to see the infor- mation normally hidden in a message through a Ctrl-A code. Information like path and kludges are normally hidden behind these codes. Please note that these commands may differ from language to language, because you can change them in the LCONFIG.EXE program. 7.3 QWK offline mail system -------------------------------------------------------------- SuperBBS is one of the first bulletin boards to support QWK packets directly. QWK is a mailreader system. this means the user downloads the messages and instead of reading them on- line, he/she can read them offline, saving a lot of money. Here's how it works. A user calls in on your board. he/she goes to the QWK menu options and selects the download command (menu option 82). First SuperBBS will ask the user if he/she wants to download the messages in QWK or ASCII format. (Most will choose QWK, sine it makes smaller packets.) Than SuperBBS will scan through the message areas for any unread mail in the areas the user selected. If there is new mail, SuperBBS will export the messages and put them in an archive. This user can download this archive. Offline, the user goes into the mail reader, for example the Silly Little Mail Reader or the BlueWave reader, which now also supports the QWK packets. He/she than reads the messages, write replies or/and new messages and on the next call uploads these messages with the upload command (menu option 83). Besides the mail package, your WELCOME.A?? and GOODBYE.A?? are packed in the archive. The same accounts for your NEWS.A?? file, if available. These will be displayed while reading the messages with the SLMR program. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 141 SuperBBS will place the QWK packets in the WORK directory, as specified in your path settings in the configuration menu. Packets are deleted after the user has downloaded them. To separate your packets from those from other Bulletin board systems, you have to give the QWK packet an unique name. (Also done in the configuration program.) The reply packets will have the same name, except for the extension, which will be .REP, instead of the .QWK for the mailpacket. With menu option 84 is the user able to select where SuperBBS will start searching for new messages. This menu option allows to change the lastreadpointer of the user. Taglines can be allowed on your system. A tagline is a little line below the message with a witty or funny textline. Not all echomail areas allow the use of the tagline, because echomail already adds an origin line to the message, giving it a double originline, when a tagline is also added. You can select to use or not use taglines in the messagebase configuration menu per area. Selecting the areas you want the mail from is done through the use of the area select command for message area 0, the global message area. (Menu option 28.) Areas which are set to On will be used to export the mail from. Areas set to Off will not be scanned for mail. It is useful to put this menu option in your QWK menu screen. Since SuperBBS now allows longer names for the areas, a special short QWK name option has been added to the configur- ation of the messagebase. Support the offline mail reader and get your users to use it. 7.4 Group messages -------------------------------------------------------------- A very powerful way to send a message to every user or just a certain security level is the Group message function. If enabled, every user who logs on to your system will get the message as if it is addressed to him/her personally. You have to address the message to: *everyone*. In this case everybody will receive the message. If posted to a certain security number, like *everyone*100, only users with security level 100 will receive the message. Post a group message always as a private message, otherwise all users can read the message. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 142 There are two options available with menu option 22 (mail check), these options are: /A Display all messages (New normal messages and new group messages). /G Display only new group messages. This message system could be used for informing your users about certain things happening on your BBS or any other infor- mation. You will have to set the security level needed to post group messages in the configuration program. This means you can also let your users send group messages. 7.5 Netmail -------------------------------------------------------------- SuperBBS is a fidonet compatible BBS program. This means you can exchange messages with other systems. These messages can be NETMAIL or ECHOMAIL. SuperBBS does use a nodelist, but you will still need a mailer who will handle the sending of the netmail, for example Front- door or D'Bridge. If you have setup a netmail directory, SuperBBS will ask you for the address the message has to be send to. Here you have to enter a valid fidonet address. If you don't know the address, you can browse through the nodelist and search for the node you want. If your replying to a message, SuperBBS will try to match the senders zone, if you have an AKA in the senders network. If SuperBBS can't match the senders zone, he will use the main address. After you supplied the destination address, SuperBBS will ask you if the message is a CRASH (or send immediately) message. Third and last question is about File attachments. You can send a file to another BBS this way. If you say YES to the previous question, SuperBBS will ask you for the filename. Then you can enter your message. Contact a BBS system running Netmail if you want more information on this subject. See the external utilities for more info on the SBBSNODE.EXE program. SuperBBS now also supports Point addresses, even if there is no nodelist available. 7.6 Echomail -------------------------------------------------------------- Echomail is mail that is distributed every night over several BBS systems. This means your message could get all over the world, depending on the area your in. This also is the most expensive form of mail. A message written on your system can be read on hundreds of other systems. All messages are always public. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 143 You can setup every message area in SuperBBS for echomail use. You can select a different AKA address (if you have them) and choose an origin line for every area (through ECHOORIG.CTL). You will need a front end program (also called mailer) to run Echomail. To run echomail you need an echomail processor. These will unpack messages from the archives they are send in and toss them to your echomail area. They also pack new messages from your system and prepare them to be transferred. | Some processors are: | | - ZmailH Echo & Netmail scanner/tosser | - TosScan Echo & Netmail scanner/tosser | - Imail Echo & Netmail scanner/tosser | - GEcho Echo & Netmail scanner/tosser | - Fmail Echo & Netmail scanner/tosser | | Gecho and Fmail now support SuperBBS completely. Please note | that most echo/netmailprocessors need the messagebase files in | the main BBS directory. There are more programs available. Ask for them at a BBS near you, running echomail. The D'Bridge mailer has net and echo- mail support build into the program and support SuperBBS. You will also need some echomail utility program. This program must be capable of linking messages, renumbering and deleting them. One of the best programs around is MBUTIL written by Gerard van der Land. This program can take care of all your echomail area maintenance and more. This is a seperate program and not included in the SuperBBS archive. 7.7 Nodelist support -------------------------------------------------------------- SuperBBS has a limited Nodelist support build in. Limited because the cost support is not yet available. SuperBBS uses the QuickBBS alike indexfiles. These are created with the SBBSNODE.EXE program. Their is a menu option available to browse through the nodelist. When entering echomail, you have the option to scan through the nodelist to find the address. SuperBBS support point addresses. If no nodelist is available, SuperBBS will still work and you can still sent netmail. Also point addresses are still sup- ported. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 144 7.8 Search userlist -------------------------------------------------------------- When enabled in the configuration program, SuperBBS allows the user who entered a non-existing name in a local message area to scan through the userlist. You can toggle this function on and off in the configuration program. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 145 Chapter 8. Files base ============================================================== 8.1 General information -------------------------------------------------------------- The filebase is just like SuperBBS messagebase compatible with RemoteAccess and QuickBBS. SuperBBS uses a FILES.BBS file to display the available files to the users. This file looks like this when viewed with a normal ASCII editor: Filename Description ^---- Cursor position 14 SuperBBS will add the information like size and date if the file is found in the current area. If not, the word defined in the lconfig program for the word offline will be displayed instead of the date and size. The description has to start on character number 14. SuperBBS allows you to have more then one file description line. You can set this information in the CONFIG.EXE program. If you want to add a line with a text editor, use one who ends without putting a Ctrl-Z at the end of the document, start the extra description line with the ' >'(ASCII 32+62) sign. This will tell SuperBBS it is a file description line and will display it at the right place. (See the example in the part of this chapter concerning the up- loader name.) | SuperBBS now also wraps the text around if the textline is | longer than 45 characters. The wrapped text will be displayed | at the right indent. You can set this in the configuration | program. You can specify to which position the long lines are | wrapped, giving you the option to make your FILES.BBS look | more neat. Here's an example of how it was in 1.16: | | SBBS_117.LZH 777777 01-02-1993 [00] SuperBBS programm for | all users. Shareware. | SNETDIFF.L00 23909 01-02-1993 [00] SuperNet nodediff | | This is how you can make it look in 1.17: | | SBBS_117.LZH 777777 01-02-1993 [00] SuperBBS programm for | all users. Shareware. | SNETDIFF.L00 23909 01-02-1993 [00] SuperNet nodediff | | When using the new files scan, SuperBBS will overwrite the | area name with the next one if there are no new files in the | area. Fileflagging and archive/text view is also available | during a new files scan. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 146 8.2 Extract and view option -------------------------------------------------------------- SuperBBS allows you and your users to extract, view and repack a file while on-line. SuperBBS has support for ZIP, LZH, PAK, ARJ and ARC files. You can extract a file, view the contents of the file, read textfiles from within the file and repack only the wanted files, while discarding the rest. SuperBBS makes use for this option of the TEMP directory which you have to set up in CONFIG.EXE. After use, SuperBBS will clean the area in case the user doesn't and you have set the option on in CONFIG.EXE. 8.3 Uploader to files.bbs -------------------------------------------------------------- SuperBBS allows you to optional put the username of the upload in the files list. This only works if you have the use of the '>' character in the files base listing set to on. SuperBBS will put the name of the uploader as the last line of the description. It will look like this: SBBS_117.LZH 777777 15-jan-91 New SuperBBS release v1.17 Full featured version. Uploader: Aki Antman This is what your users will see. In your files.bbs list it will look something like this: SBBS_117.LZH New SuperBBS release v1.17 >Full featured version. >Uploader: Aki Antman Some Sysops use this method to give you some more system security, because everybody can see which file is uploaded by whom, preventing them to send you trojanhorses or virusfiles. 8.4 FILES.CTL -------------------------------------------------------------- This file, which is a plain ASCII file, gives you control over the files in your filebase. It is possible to assign passwords to files, specify unwanted files and allow free files. Use this file as follows: <Filename> /FREE <Filename> /UNWANTED <Filename> /PWD=<password> -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 147 You can use wildcards in the filenames. If you don't specify a directory, the option will work in all file areas. Here's an example: SBBS_111.ZIP /FREE BETA_112.ZIP /PWD=BETATEST /FREE *.GIF /UNWANTED C:\TMP\ZIP.ZIP /FREE This will make the SBBS file free, protect the free file Beta with a password, tells users .GIF files are not welcome and makes the ZIP.ZIP in the TMP directory also free. | 8.5 File flagging & Archive view | -------------------------------------------------------------- | | SuperBBS has file flagging build into the program. File flag- | ging means you can select a file which you want to download, | while viewing the newfiles list or normal file list. This | command is part of the more prompt, which is shown when the | screenlength is reached, or the end of the file is reached. | You can select the key to use for this option in the language | files by using LCONFIG.EXE. The user only has to select the | commandkey and SuperBBS will ask which file to flag. Also | available is a menu option, menu type 95, with two options to | display the flagged files list and to delete files from the | list. See the menu commands for more information. | | When a user selects the download command, SuperBBS will check | if the user flagged files and will ask the user if he/she | wants to download these flagged files. | | SuperBBS makes a Filedoor/EFT compatible file BBSTAGFL.? when | a user flags a file. This file is written/read from the direc- | tory of the current node. | | A user can never flag more files than his/her downloadlimit | would allow. SuperBBS will give a warning if the user wants to | flag a file which would exceed the limit. | | Also available in the more prompt line is the option to peek | inside an archive. This is no extract command, it will just | show the contents of the specified archive. SuperBBS will ask | the user which file to show. It the file is a textfile, the | user can view the textfile with this view option. When Super- | BBS detects an archive the archive viewer is called and when | it is a textfile, the file is displayed. | | Please note that both options use full filenames, no wildcards | are allowed here. File flagging has been improved in version | 1.17 of SuperBBS. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 148 | 8.6 Download counter | -------------------------------------------------------------- | | SuperBBS has a build in download counter. This allows you to | keep track of the number of downloads for each file. In the | configuration program you will have to specify which charac- | ters you want to use as brackets. (For example: [], () or <>) | SuperBBS will keep track of the downloads and everytime a file | is downloaded will update the counter. If no counter is avail- | able, SuperBBS will add one. This makes your files.bbs file | look like this (Using [] as brackets): | | SBBS_115.ZIP 532267 15-jan-91 [17] SuperBBS version 1.15 | Full featured version | Uploader: Aki Antman | SDOC_115.ZIP 100001 15-jan-91 [02] SuperBBS documentation | Uploader: Frank Hemmelder | SUPERNET.A68 32180 15-jan-91 [00] New SuperNet nodelist | Uploader: Robbert Roos | | Please note that SuperBBS does fill out the counter when below | the 10. Also new uploaded files will have a counter set to | zero. Both options can be set in the configuration program. When you set the brackets option in the configuration program to spaces, the downloadcounter will be disabled. 8.7 Default protocol -------------------------------------------------------------- SuperBBS now allows your users to have a default protocol. This means that SuperBBS will not ask the user which protocol to use, but will go straight to the download start, if the user has selected a default protocol. Users can select a default protocol with menu command 97. (See menu commands). There is also an ANSI/ASCII file available to show the available protocols, instead of the normal protocol list. (See support files for more information.) New users can get the question to select a default protocol at their first logon, if enabled. Already existing users should use the menu command (97) to select a default protocol. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 149 Chapter 9. Support files ============================================================== 9.1 General information -------------------------------------------------------------- SuperBBS uses a whole range of extra ANSI and ASCII support files. You can define these files yourself, or use the build in (English) messages. This way you can personalize your system. If a file is not available, SuperBBS will display a message of it's own, if needed. You can make these ANSI and ASCII files with a program like Thedraw. It even allows you to use animation in your ANSI files. Do remember that users are calling in and that a long screen build up will scare them away, or they switch to ASCII. SuperBBS will first look for the files in the ANSI/ASCII textfile directory specified in the language files, then in the text directory specified in the CONFIG.EXE program and if still no file is found, it will display the message of it's own, which is normally just a textline explaining what is going on. 9.2 ANSI and ASCII Support files -------------------------------------------------------------- These are the support files: Name.........: 0001 (0102, 0203......2223, 2324) Type.........: ANS/ASC Description..: File to be displayed at logon, between 00:00 and 01:00 hrs. This way you can setup a file for every hour. 1516.ANS would be displayed between 15:00 and 16:00 hrs. Name.........: ALIASASK Type.........: ANS/ASC Description..: This file is displayed at logon of a newuser just before asking the alias he/she wants to use. This file should contain some information about the use of an alias on your board. Name.........: ALTNEWS Type.........: ANS/ASC Description..: This file is displayed to IEMSI users who selected not to view the normal NEWS.A?? file. This way you can still give them some news information. This file is not shown to not IEMSI users. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 150 Name.........: APHORISM Type.........: ANS/ASC Description..: Shown to the user before the aphorism (menu option 85) is shown to the user. | Name.........: B?????? | Type.........: ANS/ASC | Description..: Shown to the user with the BPS rate as spe- | cified behind the B. B2400.A?? would be shown to | a 2400 BPS caller and B14400.A?? would be shown | to a 14400 BPS caller. You can make a file for | the following BPS rates: | | 300 | 1200 | 2400 | 4800 | 7200 | 9600 | 12000 | 14400 | 16800 | 19200 | 38400 | | Other BPS rates are not available within Super- | BBS. Name.........: BFAILED Type.........: ANS/ASC Description..: Shown to the user when he/she enters a wrong birthday at the birthday verification check. Name.........: BIRTHDAY Type.........: ANS/ASC Description..: Shown when a user calls on his/her birthday. Name.........: BVERIFY Type.........: ANS/ASC Description..: Shown to the user when he/she is asked to give his/her birthday as part of the system security check. Name.........: DEFPROT Type.........: ANS/ASC Description..: Shown to the user instead of the normal build in protocol list when the user has to select a default protocol. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 151 Name.........: DNLDHRS Type.........: ANS/ASC Description..: Shown to a user who wants to download when downloading is not allowed as specified in CONFIG.EXE. Name.........: DPHONE Type.........: ANS/ASC Description..: Shown to the user when he/she enters a dupe phonenumber and the configuration has been set to disconnect the user after showing this file. Name.........: EDITHELP Type.........: ANS/ASC Description..: Shown to the user when he/she asks for help within the message editor. Name.........: FGOODBYE Type.........: ANS/ASC Description..: Shown to the user when he/she decided to logoff after a file transfer. Do not use the code Ctrl-A (= Press return) in this screen, other- wise the user can't use the automatic logoff, because SuperBBS will wait for the return. Name.........: GOODBYE Type.........: ANS/ASC Description..: Shown to the user at logoff, just before the modems disconnect. Name.........: LOGO Type.........: ANS/ASC Description..: Shown to the user before asking the user's name at logon to your system. At this moment is SuperBBS not aware which language a user is using, so it uses the directory specified in the first language file in LANGUAGE.CTL. If you are using different languages, this file should contain all available languages. Name.........: LOGONAGE Type.........: ANS/ASC Description..: Shown to the user when he/she is too young to logon to your system, as set in the configur- ation program. Name.........: LOGONFLA Type.........: ANS/ASC Description..: Shown to the user when he/she doesn't have the correct flagsettings for login in on your sys- tem, as specified in the configuration program. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 152 Name.........: LOGONPWD Type.........: ANS/ASC Description..: Shown to the user when he/she gives the wrong password for logging on to your system, when you have specified a global password in the configuration program. Name.........: LOGONSEC Type.........: ANS/ASC Description..: Shown to the user when his/her security level is not high enough to logon to your system, as specified in the configuration program. Name.........: MAXPAGE Type.........: ANS/ASC Description..: Shown to the user when trying to page the Sysop more times then specified in CONFIG.EXE. Name.........: MSGAREA Type.........: ANS/ASC Description..: Shown to the user at menu type 68, instead of the normal build in area list. Name.........: NEWS Type.........: ANS/ASC Description..: File displayed to every user at logon. Useful for newsflashes. Programs like SXNEWS are easy for creating and editing this file. When a user uses IEMSI to login, he/she can select to not view this file. (See also the ALTNEWS file.) SuperBBS now allows you to select if you want this file to be shown to the user every time somebody logs on, or just when it is updated. SuperBBS will remember the date the user last read the file and will show the news file only if the date of the file is newer. Name.........: NEWS1 Type.........: ANS/ASC Description..: File shown directly after the NEWS.A?? file. Name.........: NEWUSER1 Type.........: ANS/ASC Description..: Shown to newusers after he/she has verified his/her name and before the other logon ques- tions are asked. At this point does SuperBBS not know which language the user wants to use, so you should make this file contain all avail- able languages. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 153 Name.........: NEWUSER2 Type.........: ANS/ASC Description..: File displayed to a new user after he/she answered the questions about system options and selected a password, but before the NEWUSER.Q-A questionnaire is answered. Name.........: NO300 Type.........: ANS/ASC Description..: Shown to the user trying to logon to your BBS at 300 Baud when this is not allowed as you specified in the CONFIG.EXE file. Name.........: NOCHAT Type.........: ANS/ASC Description..: Shown to the user when his/her name is found in the NOCHAT.CTL control file and the user tries to use this option. Name.........: NOPAGE Type.........: ANS/ASC Description..: Shown to the user when you are paged, but you disabled yell with the Scroll-lock key. Name.........: NOREMOTE Type.........: ANS/ASC Description..: Shown to the user when remote Sysops logins are disabled and somebody tries to get in with your name. Name.........: NOTAVAIL Type.........: ANS/ASC Description..: Shown to the user when you are paged outside yelling hours. Name.........: NOTFOUND Type.........: ANS/ASC Description..: Shown to the user if the system can't find the user's name in the user list. At this moment is SuperBBS not aware of the language the user is using or want to use. This file should there- fore contain all available languages. Name.........: NOYELL Type.........: ANS/ASC Description..: Shown to the user when his/her name was found in the NOYELL.CTL control file and the user tries this option. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 154 Name.........: NUSERPWD Type.........: ANS/ASC Description..: File shown to the users when you have specified a newuser password on your system. This file is shown to the users before SuperBBS asks for the password. Name.........: PAGEABRT Type.........: ANS/ASC Description..: Shown to the user when the Sysop aborts the yell from the user. Name.........: PAGED Type.........: ANS/ASC Description..: Shown to the user after a yell for the Sysop, incase the Sysop didn't answer. Name.........: PAGEQUES Type.........: ANS/ASC Description..: Shown to the user when yelling the Sysop, just before the user is asked for the reason of the page. Name.........: PASSWORD Type.........: ANS/ASC Description..: Shown to the new user just before the system asks for a password, or just before the user has the option to change his/her password. Name.........: PRIVATE Type.........: ANS/ASC Description..: Shown to the user if your system is a private system and a non-registered user is trying to get in. The user will be disconnected after displaying the file. Name.........: RATIO Type.........: ANS/ASC Description..: Shown to the user when the upload/download file ratio is exceeded as configured in CONFIG.EXE. Name.........: RATIOK Type.........: ANS/ASC Description..: Shown to the user when the upload/download kbytes ratio is exceeded as configured in CONFIG.EXE. Name.........: READHELP Type.........: ANS/ASC Description..: Shown to the user if he/she asks for help with the read, scan and quickscan commands. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 155 | Name.........: RULES | Type.........: ANS/ASC | Description..: File shown a specified number of times to new | users on your BBS system. Configuration about | the number of times the file is shown is in the | configuration program. Name.........: SECxxxxx Type.........: ANS/ASC Description..: Shown to the user just after the welcome screen if he/she has the security level 'xxxxx'. 'xxxxx' has to be a value between 0 and 32000. (SEC20.ANS will be shown to security level 20 user's.) If this file is not found, SuperBBS will look for a SECALL.A?? file. Name.........: SECALL Type.........: ANS/ASC Description..: Shown to the user if for his/her security level no SECxxxxx.A?? file is available. | Name.........: SUBWARN | Type.........: ANS/ASC | Description..: Shown to the users who are within 31 days of | their expiration date. Name.........: TIMEWARN Type.........: ANS/ASC Description..: Shown to the user when his/her time is adjusted due to an upcoming event. Name.........: TOOSLOW Type.........: ANS/ASC Description..: Shown to the user when trying to logon to the system at a bps rate which is not fast enough, as configured in CONFIG.EXE. Name.........: TRASHCAN Type.........: ANS/ASC Description..: Shown to the user when his/her name was found in the TRASHCAN.CTL list. The user will be disconnected after displaying the file. Name.........: VIP Type.........: ANS/ASC Description..: Shown to the user after the welcome screen if his/her name was found in the VIP.CTL list. Name.........: WELCOME Type.........: ANS/ASC Description..: Shown to the user after he/she entered her name and password. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 156 Name.........: WELCOME1 Type.........: ANS/ASC Description..: Shown just after the welcome screen. Name.........: XFERHELP Type.........: ANS/ASC Description..: Shown to the user when the user asks for help with the transfer protocols and file transfer. Name.........: XFERPROT Type.........: ANS/ASC Description..: Shown to the user when he/she selects the down- load option. This file will replace the normal build in protocol list. 9.3 .CTL, .LNG and .BBS Support files -------------------------------------------------------------- Besides the ANSI and ASCII files, SuperBBS uses a couple of .CTL, .LNG and .BBS files to control his behaviour. The .CTL files are all plain ASCII files and can be edited with every normal texteditor, even Edlin if you like. The .BBS files are all controlled through the CONFIG.EXE program. The .LNG files are language files and are controlled through the LCONFIG.EXE program. The .BBS and .LNG files are mentioned here as refer- ence, so you know what every file is for. Their set up is explained in detail in chapter 3. Type.........: *.LNG Description..: Language support files. Type.........: AREAS.BBS Description..: Not a file needed for SuperBBS, but most echomail processors need this file, that's why we mention it. It contains information about your message areas and who to send them to. The format is as follows: <Area Nr.> <Description_of_area> <Destination> Don't use the first three lines of the file. Just put a ';' in there. This is just a plain ASCII file. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 157 Type.........: ANSIF.CTL Description..: It is now possible to any text at logon to your users. This is done by making an ASCII file called ANSIF.CTL. SuperBBS will show all files listed in this file to every user at logon. The file looks like this: LOGON IMPORT C:\SUPERBBS\SBBSHQ.TXT If no extension is included, SuperBBS will show the ANSI or ASCII file, depending on the user settings. In our example SuperBBS would show LOGON.ANS if the user has ANSI enabled, other- wise LOGON.ASC would be shown. These files have to be in the directories as specified by the configuration of the language files. You can show however every file you want by including the path to the file, like the third file in the example. The file will be displayed as the DOS command TYPE would do, so viewing binary files is not possible, but ANSI is possible. Type.........: BADALIAS.CTL Description..: Contains names which you as Sysop don't want to be used as aliases on your system. The format of this ASCII file is: Bad alias Bad alias Bad alias You can make this file with every normal ASCII text editor. Type.........: BBSTAGFL.??? Description..: Made by SuperBBS when a user flags a file for download. This file is Filedoor/EFT compatible and is written/read from in the directory of the current node. Type.........: CONFIG.BBS Description..: Contains the complete setup from your system. This file should never be deleted, because you will have to setup your system again. Type.........: DOORS.BBS Description..: Configuration file for the doors you have set up in the configuration program. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 158 Type.........: DORINFO?.DEF Description..: One of two files, the other is the EXITINFO.BBS file, which contains information to be used by programs running outside SuperBBS. These files are generated when you do a type 7 or 15 exit. Type.........: ECHOORIG.CTL Description..: Plain ASCII file. With this file it is possible to have a different origin line in every mail area. The format of the file is as follows: <AreaNr.> <Origin line> <AreaNr.> <Origin line> SuperBBS searches for this file in the direc- tory where your BOARDS.BBS file is situated. You can either edit this file with a normal ASCII editor or through the configuration pro- gram. Type.........: EXITINFO.BBS Description..: One of two files, the other is the DORINFO1.DEF file, which contains information to be used by programs running outside SuperBBS. These files are generated when you do a type 7 or 15 exit. Type.........: FILES.CTL Description..: This file, which is a plain ASCII file, gives you control over the files in your filebase. It is possible to assign passwords to files, spec- ily unwanted files and give free files. Use this file as follows: <Filename> /FREE <Filename> /UNWANTED <Filename> /PWD=<password> You can use wildcards in the filenames. If you don't specify a directory, the option will work in all file areas. Here's an example: SBBS_111.ZIP /FREE BETA_112.ZIP /PWD=BETATEST /FREE *.GIF /UNWANTED C:\TMP\ZIP.ZIP /FREE This will make the SBBS file free, protect the free file Beta with a password, tells users .GIF files are not welcome and makes the ZIP.ZIP in the TMP directory also free. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 159 Type.........: FLSEARCH.BBS Description..: Contains all information about your file areas. Location, securitylevels, flagsettings, age to have access and if in the menu templating is stored in this file. Type.........: LASTREAD.BBS Description..: Contains information about every user and his/her lastread message number. Never delete this file, because all message will be displayed as new messages to the user's. Type.........: LIMITS.BBS Description..: Contains the information about userlevels and their limits. SuperBBS checks this file to find the information about the userlevels. Type.........: MSGIDX.BBS / MSGINFO.BBS / MSGTOIDX.BBS / MSGHDR.BBS / MSGTXT.BBS Description..: Contains the information about the messages on your system. If you want to start with a new and empty database, delete these files. Type.........: NAMEIDX.BBS Description..: SuperBBS uses this file to make the userfile search a lot faster. It is a small file used by SuperBBS. Note that if you run non SuperBBS software to pack/edit your userbase, you will have to run USERPACK.EXE everytime after that program. You can also switch the use of this file of in the configuration program, but we strongly suggest you do this only when nothing else will work or you are having problems with NAMEIDX.BBS searches. Type.........: NOAGECHK.CTL Description..: When a users name is found in this plain ASCII control file, this user will be able to login to your system, even when he/she would be too young, as specified in the configuration of your system. The format is similar to the trashcan file. Type.........: NOBCHECK.CTL Description..: When a user logs on to your system and his/her name is found in this plain ASCII control file, he/she will never have to enter his/her birth- day as a verification check. The file format is the same as the trashcan file. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 160 Type.........: NOCHAT.CTL Description..: When a users name is found in this plain ASCII file, this user is never able to use the node- chat function. A file called NOCHAT.A?? will be displayed to the user. The format is similar to that of the trashcan file. Type.........: NODEIDX.SBS / NODEINC.SBS Description..: The two index files generated by the SBBSNODE.EXE program from the raw nodelist. These two files are needed if you use the node- list support in SuperBBS. Type.........: NOYELL.CTL Description..: When a users name is found in this plain Ascii control file, this user will not be able to page the Sysop for a chat. The file NOYELL.A?? will be displayed to the user. The format is similar to that of the trashcan file. Type.........: PFILES.BBS Description..: Contains information about private uploads done to you. This is a normal ASCII file. All pri- vate upload descriptions are stored in this file. Type.........: PHONENUM.CTL Description..: This file prevents users from entering illegal phonenumbers. It works the same way as the trashcan file. When a phonenumber is entered, it is compared to this list and when there is a match, the user is warned. When a string is found _anywhere_ in the entered phonenumber, SuperBBS will react. Here is an example: 000- -0000 06-11 Phonenumbers containing these strings _ANYWHERE_ in the number will not be accepted. For example 956-00001234 or 9006-110023 will not be accepted by SuperBBS. Don't make your control file to complex, use common sense. Type.........: SBBSBUSY.? Description..: This file is created by SuperBBS while running. The ? is the node number. This file is even created on single line systems. Since this file is created in the common directory, check your configuration. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 161 Type.........: SLCALLER.BBS Description..: Contains information about the last 15 users to your BBS. You can delete this file if you want, but there should be no reason for it. Type.........: SPROTO.BBS Description..: Configuration file for the external protocols. Type.........: SUSERS.BBS Description..: Contains the extra user information like age, birthday, sex etc. Only delete this file if your userbase is messy and you want to clean it up. SuperBBS will ask every user for the needed information again. Type.........: TIMELOG.BBS Description..: Contains information about the usage of the BBS. The usage log is created out of this file. If you want to start all over with your usage log, delete this file. Type.........: TRASHCAN.CTL Description..: Contains user names you don't want to have on your board, like Sysop, Dr., Hacker etc. This is a plain ASCII file in the following format: User name User name User name Type.........: USERDOES.? Description..: If SuperBBS finds the file USERDOES.?, where the ? is the node number, in the main SuperBBS directory, it will display it when menu type 75 is used. This file allows you to show a more specific line when the user asks the status of the other line. When this file contains "Play- ing Tradewars", SuperBBS will show this if the user executes menu type 75 (with /S option). Type.........: USERS.BBS Description..: Contains the information about the users. All normal user information is stored in this file. Only delete this file if you want to start with 0 user's. Backup this file often to prevent damage to your userfile if something happens. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 162 Type.........: VIP.CTL Description..: Contains information about special users to your BBS system. SuperBBS will show the file VIP.A?? to them at logon. This is a plain ASCII file with the following format: <User name> <User name> <User name> | Type.........: YELLTUNE.CTL | Description..: You can define specific tunes for some users or | certain userlevels. The format of this file, | which is stored in the main SuperBBS directory | is: | | Name Tune | Name Tune | Security Tune | | Here's an example: | | Aki Antman AKITUNE.CTL | 200 SEC200.CTL | | This would play the tune set in AKITUNE.CTL | when Aki Antman would yell and it would play | the SEC200.CTL file when a user with level 200 | would yell. SuperBBS uses four logfiles for storing system information. One type you hopefully never have to see. These files are: Type.........: ERRORS.LOG & ERRORS.BBS Description..: Contains all errors which occur during oper- ation of SuperBBS. Please take note of these files and send the information to us, when you come across an error. Send this information to our support nodes or the SuperBBS HQ. Type.........: SBBSDOWN.LOG Description..: Contains all downloads done from your system and the names of the user who downloaded the file. Type.........: SBBSUP.LOG Description..: Contains all uploads done to your system and the name of the uploader. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 163 Type.........: SYSTEM.LOG Description..: Contains all information about what the user did on your system. Information like name, userlevel, alias, wrong passwords, exits to doors and time on-line are stored in here. This file is a plain ASCII file. If this file is missing, SuperBBS will create it the next time it is run, so you can delete this file as many times as you wish. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 164 Chapter 10. Questionnaire language ============================================================== 10.1 General information -------------------------------------------------------------- SuperBBS has a powerful questionnaire language available to the Sysop for designing question files. SuperBBS will run the questionnaire called NEWUSER.Q-A if a new user enters your system and the file is found. Answers will be stored under the same filename, but with the extension .ASW. All questionnaires have to have the extension .Q-A and all answer files will have the extension .ASW. You can design as many questionnaires as you like. You can run a questionnaire from a menutype 12. On the optional datafield, you have to supply the name of the questionnaire. 10.2 Available commands -------------------------------------------------------------- Here's a list of the available commands in the questionnaires: Used codes: <.......> = Mandatory [.......] = Optional Command.....: ASK <length> <variable> [default] Description.: Asks for a string from the user. Length defines the number of characters the answer can take, the variable is the answer number, which you can use in combination with other commands. The option Default allows you to enter some infor- mation as default in the answer field. If you use as default USERNAME, this will be replaced through the username of the user answering the questionnaire. Example.....: ASK 40 1 USERNAME Command.....: CAPITALIZE <on/off> Description.: If capitalize is on, all first letters of the words entered in an answer field will be capi- talized. If off, the user decides if a letter is capitalized through the use of his/her Shift(-Lock) key. Example.....: CAPITALIZE ON Command.....: CHANGECOLOR <foreground> <background> Description.: Changes colour to the given combination. Fore- ground (or textcolour) can be between 0 and 15, background between 0 and 7. See earlier in this documentation for a complete list of the col- ours. Example.....: CHANGECOLOR 14 1 -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 165 Command.....: CLEARSCREEN Description.: Clears the screen if user has selected CLS codes. Example.....: CLEARSCREEN Command.....: DISPLAY <"text"> Description.: Displays a text to the user. The pipe symbol '|' acts as a carriage return. Every textline should not exceed the screen width. If no '|' is given, SuperBBS will continue at the end of the last line. Use the '|' also after the GETCHOICE command as the first character of a textline. You can use as many '|' symbols behind each other as you like. Example.....: DISPLAY "Welcome to this BBS system.|" Command.....: DISPLAYASW <variable> Description.: Shows the answer given to the question given as the variable. This should be the same variable as used with the question. Example.....: DISPLAYASW 1 Command.....: DISPLAYFILE <filename> Description.: Displays the file given as filename from the textfile directory. If the user has ANSI enabled this will be the ANSI version if avail- able, otherwise the ASCII version is shown. SuperBBS first looks in the directory specified in the language file, then in the directory specified in CONFIG.EXE. Example.....: DISPLAYFILE WELCOME Command.....: DOMENUC <menutype> <"data"> Description.: This command will run the menu command (see list for numbers) given as data in the menutype field. The information given in the data field will be displayed to the user. Example.....: DOMENUC 11 "Yelling Sysop" Command.....: ENDIF Description.: Use this command as the end of an IF loop. (See the IF command.) Example.....: ENDIF Command.....: EXEC <command> Description.: Executes the program given as the command option. This allows you to execute an external program. This program should be in the path or current directory. Example.....: EXEC USERCHEC.EXE -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 166 Command.....: GOTO <label> Description.: This command allows you to jump to a character or value. Label must be ONE character or a value. The place GOTO will jump to is deter- mined by the same character or value preceded by a colon ':'. So the command GOTO A, will jump to :A. Example.....: GOTO B Command.....: GETCHOICE <options> <variable> [default] Description.: This command allows you to ask the user a ques- tion, with only a limited one character answer available. Options are the characters which are valid for this answer, variable is the question number the answer should be stored under in memory and default is the default answer, so when a user just presses ENTER, it will default to the answer stated in default. Example.....: GETCHOICE YN 2 Y Command.....: IF <variable = "string"> Description.: This command allows you to jump over certain parts of your questionnaire if the compiled variable does not match the given string. Vari- able is the question number stored in memory and string is the string to match. SuperBBS will compile the user's answer and compare it to the string. If this doesn't match, SuperBBS will jump to the first ENDIF found. Example.....: IF 1 = "Frank Hemmelder" Command.....: OUTPUTANSWER ["string"] <variable> Description.: This commands allow you to store the answers given by the user in an ASCII file with the same name as the questionnaire, but with an ASW extension. String is the text which should be placed in front of the answer, variable is the number of the answer stored in memory. Example.....: OUTPUTANSWER "Full name : " 1 Command.....: POSTINFO Description.: This command will write the current system time, data and the username to the answer file. This command should be used in front of the OUTPUTANSWER lines. Some programs, like READANS.EXE, allows you to upgrade newusers easily by reading the answers in the NEWUSER.ASW file, but they need the information from POSTINFO to separate the different users. Example.....: POSTINFO -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 167 Command.....: QUIT Description.: Ends the questionnaire. This does not mean this command has to be at the end of all the ques- tions. If you use the IF and ENDIF commands, this could be half way through your question- naire. Example.....: QUIT | Command.....: SETFLAG <flag> <on/off/toggle> | Description.: Allows you to change a flagsetting from the | current user. Flag should be a character/number | combination, flags are numbered A1 to D8, and | they should be followed by the on or off com- | mand or the toggle command. The toggle command | is used to switch the flagsetting around. For | example SETFLAG B6 TOGGLE will toggle the B6 | flag. | Example.....: SETFLAG B5 TOGGLE Command.....: SETSECURITY <level> Description.: Allows you to change the userlevel. Level should be the new level. Example.....: SETSECURITY 0 Command.....: WAITENTER Description.: This command displays the 'Press ENTER to continue' string and waits for the user to press the ENTER key. The 'Press ENTER....' will be done in the current language. Example.....: WAITENTER 10.3 NEWUSER.Q-A & EXPIRED.Q-A -------------------------------------------------------------- The NEWUSER.Q-A is run, when available, everytime a new user logs on to your system. Here you can ask questions like the address of the user, his/her requirements or anything else you would like to know, before you give access to your system. (An example is below.) The EXPIRED.Q-A is run everytime a user's expiration date has reached 0. In this questionnaire you can change levels, change flagsettings, tell the user how he can get his/her level back and many other things. You can use as many questionnaires as you might need, but these two are special. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 168 10.4 Questionnaire example -------------------------------------------------------------- Now let's have a look at this little example. You could use it, but I recommend you change it and make it better. It will first display a textfile to the user, stating the rules of the BBS, then ask the most important questions and asks if you are a Sysop. If you are, you'll be able to enter your BBS informa- tion. Then all answers are displayed, so the user can check them and eventually start all over if he/she made a mistake. This is an example of a NEWUSER.Q-A questionnaire. CLEARSCREEN DISPLAYFILE RULES CHANGCOLOR 11 0 CAPITALIZE ON DISPLAY "Do you still want to continue? (Y/n) " GETCHOICE YN 1 Y CAPITALIZE OFF IF 1 = "N" SETSECURITY 0 CHANGECOLOR 14 4 DISPLAY "You will be logged off now!" QUIT ENDIF :A CLEARSCREEN CHANGECOLOR 10 0 DISPLAY "|Your full name........: " ASK 40 2 USERNAME CHANGECOLOR 10 0 DISPLAY "Address................: " ASK 40 3 CHANGECOLOR 10 0 DISPLAY "City and State.........: " ASK 40 4 CHANGECOLOR 10 0 DISPLAY "Telephone number.......: " ASK 15 5 CHANGECOLOR 10 0 DISPLAY "|Are you a Sysop? (y/N) " CAPITALIZE ON GETCHOICE YN 6 N CAPITALIZE OFF IF 6 = "Y' CHANGECOLOR 10 0 DISPLAY "BBS name...............: " ASK 40 7 CHANGECOLOR 10 0 DISPLAY "Telephone number.......: " ASK 15 8 ENDIF CHANGECOLOR 13 0 -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 169 DISPLAY "|Thank you for filling out all the questions." DISPLAY "|Now you can check your answers.| WAITENTER CLEARSCREEN CHANGECOLOR 11 0 DISPLAY "|These are your answers: " CHANGECOLOR 10 0 DISPLAY "|Name..................: " DISPLAYASW 2 CHANGECOLOR 10 0 DISPLAY "Address................: " DISPLAYASW 3 CHANGECOLOR 10 0 DISPLAY "City and State.........: " DISPLAYASW 4 CHANGECOLOR 10 0 DISPLAY "Telephone number.......: " DISPLAYASW 5 CHANGECOLOR 10 0 IF 6 = "Y' CHANGECOLOR 10 0 DISPLAY "BBS name...............: " DISPLAYASW 7 CHANGECOLOR 10 0 DISPLAY "Telephone number.......: " DISPLAYASW 8 ENDIF CHANGECOLOR 14 1 DISPLAY "|All answers correct? (Y/n) CAPITALIZE ON GETCHOICE YN 9 Y CAPITALIZE OFF IF 9 = "N" GOTO A ENDIF CHANGECOLOR 12 0 DISPLAY "|Thank you for answering all questions." DISPLAY "|The answers are now stored." POSTINFO OUTPUTANSWER "Name.........: " 2 OUTPUTANSWER "Address......: " 3 OUTPUTANSWER "City & State.: " 4 OUTPUTANSWER "Phone........: " 5 IF 6 = "Y" OUTPUTANSWER "BBS name.....: " 7 OUTPUTANSWER "Phone........: " 8 QUIT -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 170 Chapter 11. Running SuperBBS ============================================================== 11.1 General information -------------------------------------------------------------- | SuperBBS can be run as a stand alone program or with a front- | end mailer like Intermail, Frontdoor, Portal of Power, | D'Bridge or any other mailer program. In both cases you need | to run SuperBBS from a batchfile. Examples are given further | on in this documentation. If you are using SuperBBS with a mailer, please read all the documentation of the mailer program carefully, so you know how the two programs interact with each other. 11.2 Command line options -------------------------------------------------------------- SuperBBS can be started by running the program BBS.EXE without any parameter. This will put the main SuperBBS program on- line. You will see a SuperBBS screen with some information, like time and date, last user and more. When this screen is visible (or the screensaver is working) you have two options: [L] This will put the BBS program in local mode. This way you will be able to connect to the system, just like you are running the system remotely. Beware that if you have any door programs installed which uses a Carrier Detect monitor, these won't run because there is no carrier signal available. [ESCAPE] Shutdown SuperBBS and returns you to the DOS prompt. There is a third option, this is that you get a caller on- line. SuperBBS will connect at the right modem speed and will handle the connection. A carrier check is build in, so if the user disconnects, the system will restart (if run from a batchfile). To start the BBS program in local mode, use the -L option. This option and the other command line options are as follows: Type.........: -Bxxxx Description..: Starts SuperBBS with a BPS rate of xxxx. This is a value between 300 and 38400, depending on your modemspeed. This option is mostly used in a batchfile running a mailer, telling SuperBBS at what BPS rate the user is calling. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 171 Type.........: -Exxx Description..: Tells SuperBBS to exit the call with errorlevel xxx. This can be handy if you wish to start some external program after SuperBBS finishes. Type.........: -L Description..: Starts the SuperBBS program in Local mode. Type.........: -Oxxxxxx Description..: This option will increase the overlay buffer with xxxxxx bytes. (For a 286-12 Mhz machine this should be somewhere between 50000 and 100000 bytes.) Experiment a bit with it to find the right value. This will speed up the Super- BBS operation on slow machines or machines with no EMS. This option defaults to 50000 bytes. Type.........: -Px Description..: Tells SuperBBS what COM port to use for the connection. You can use this command to over- ride the settings in the configuration program. Don't forget to use the -Px option also when returning from a type 15 exit. Type.........: -R Description..: Tells SuperBBS it is already connected to a caller and just has to restart the main pro- gram. This option is used after a type 15 exit. Type.........: -T Description..: Tells SuperBBS the user has -T time left. This time is forwarded by the mailer, to prevent an overshoot of an event. Frontdoor uses this in it's DOBBS.BAT file. (Frontdoor v2.01 has a bug at 14400 EC, stating the -B command as 9600 Bps, instead of the correct Bps). See your mailer manual for further information on call- ing the BBS. Type.........: -* Description..: Tells SuperBBS not to load the overlay file in EMS. Combinations of these parameters are possible. These parame- ters are not necessary to run the SuperBBS program, but are sometimes needed. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 172 11.3 On-line Sysop keys -------------------------------------------------------------- While the SuperBBS is on-line and a caller is in the system, the sysop has several keys which he/she can use. All Fx keys refer to the status line which is shown at the bottom of the local screen. All keys apply to the current user on-line. All the available keys are: Type.........: F1 Description..: Shows user's information on status line. Name, city, bps rate, securitylevel, times called, time left and line number are displayed. Type.........: F2 Description..: Shows user's flags. Type.........: F3 Description..: Shows user's up/download levels and ratio. Type.........: F4 Description..: Shows chat reason (if any) and if the Sysop is available. Type.........: F5 Description..: Shows sysop comment (from SBBSUSER.EXE) and alias information. Type.........: F6 Description..: Shows the current time and date, user's phone numbers, total calls to system, number of mess- ages written and last caller. Type.........: F7 Description..: Shows the last and first time and date the user called, and the expiration date of the user. Type.........: F8 Description..: Shows the information you have set in the con- figuration program. This function key if programmable by you. Note that the maximum line length cannot be exceeded (80 characters). You can use all control codes in these two lines. Type.........: F9 Description..: Remove status lines from screen. This gives you the same view as the user. Type.........: F10 Description..: Gives information about the on-line keys -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 173 Type.........: ALT-C Description..: Chat with the user. A message will be displayed to the user at the start and finnish of the conversation. Type.........: ALT-E Description..: Run the on-line user editor. This allows you to edit the current user. All changes will be saved in the user file. A message will be dis- played to the user, unless you have CapsLock on. Type.........: ALT-F Description..: Change the current user's flagsettings. All changes will be saved in the user file. A mess- age will be displayed to the user, unless you have CapsLock on. Type.........: ALT-H Description..: Disconnect user without showing GOODBYE.A??. | Type.........: ALT-J | Description..: Shell to DOS from SuperBBS. SuperBBS can swap | to EMS or disk if allowed through the | CONFIG.EXE program. A message will be displayed | to the user when you shell out and when you | return. SuperBBS will remind you that you are | in a DOS shell. Type.........: ALT-L Description..: Locks the user out of your system. He/she will be disconnected and his/her level will be lowered to 0. Type.........: ALT-N Description..: Sysop next mode. This will halt the system after the user currently online has logged of for a short period and a beep will be heard. This allows you as the Sysop to enter the BBS. If after 45 seconds you did not react, the BBS will be normally restarted. (Or your mailer will be started.) Type.........: ALT-S Description..: Change the caller's security level. A message will be displayed to the user, unless CapsLock is on. Type.........: ALT-T Description..: Change the timelimit for the user for this call. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 174 Type.........: ALT-1 Description..: Generate line noise. This can be useful if you want a user off-line. Type.........: ALT-2 Description..: Toggle the ratio check for the current user on or off. Type.........: ALT-3 Description..: Set a new download limit for this call. Type.........: ALT-4 Description..: Generates a BEEP on the user's console. Type.........: ALT-5 Description..: Toggle output to user's screen on or off. Type.........: ALT-6 Description..: Toggle user's keyboard on or off. | Type.........: ALT-7 | Description..: Disables the current user from the online user | list. This option only works for the current | call. Type.........: Up arrow Description..: Increase time limit with 1 minute. Type.........: Down arrow Description..: Decrease time limit with 1 minute. Type.........: Scroll lock Description..: Toggle Sysop availability on/off. Status lock on means Sysop not available. Also no messages are send to the user, when the Sysop changes the user information. 11.4 User's on-line keys -------------------------------------------------------------- Just as the Sysop has the user some special keys on-line. These are: Type.........: P Description..: Pause all output from text. Type.........: S Description..: Abort current operation. This works in most places in the SuperBBS program. Type.........: Ctrl-C Description..: Stops Sysop yell and message scan. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 175 Type.........: Ctrl-Y Description..: Clears any input line. (When you have to answer a question.) As of version 1.10, SuperBBS supports the 'normal' text editor keys as usable keys at input fields. This means you can use the arrow keys, Ctrl-T, Ctrl-Y, Insert, Delete, Home and End keys while entering text. 11.5 Errorlevels -------------------------------------------------------------- SuperBBS normally exits with an errorlevel. You can influence the 'normal' exit through the -Exxx command parameter (see above), but there are some more errorlevels reserved for SuperBBS. Here they are: Errorlevel...: 0 Description..: Normal exit, no problems encountered. Errorlevel...: 2 Description..: Sysop dropped to DOS by pressing ESCAPE in stand alone mode. Errorlevel...: 3 Description..: User logged off and entered Netmail. Errorlevel...: 4 Description..: User logged off and entered Echomail. Errorlevel...: 5 Description..: User logged off and entered both Net and Echo- mail. In general it is useful not to use the errorlevel of 10 and below. These levels are mostly used to control program behav- iour. 11.6 Yell and chat -------------------------------------------------------------- SuperBBS has a chat option build in to the main program. When a user tries to yell for you, the SuperBBS program will ask for a reason. Then, if a reason is entered, the system will page you. Normally this is a creeping siren sound, but you can choose a melody through the use of YELLCFG.EXE. This program allows you to choose a page melody. You can even write your own tune, check the SBBSYELL.CFG file for an example. If you want to randomly change the tune every day, run the following option in your daily maintenance: YELLCFG.EXE CHANGE. This will take a different melody from the list every time it is run. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 176 The chat will be in two colours and if ANSI available it will be full screen by default. One window for the Sysop and one for the user. (Naturally only when user has ANSI on.) If the Sysop starts a chat, the user will get all the time spent in the chat back after ending the chat. If the user starts the chat, the time will continue. If you don't want the full screen chat, press the Left-Shift key, while pressing Alt-C or when you answer the chat. SuperBBS will display an ANSI/ASCII file before the user is asked for the reason to chat. This file is called PAGEQUES.A?? and should be in your textfile directory. Five keys are available during a chat: Type.........: Ctrl-A Description..: Toggle capture file on/off Type.........: Ctrl-B Description..: Display an ANSI/ASCII file Type.........: Ctrl-Y Description..: Clears current line Type.........: Ctrl-R (in Fullscreen chat) Description..: Redraws the screen Type.........: Ctrl-W (in Fullscreen chat) Description..: Clears the your window The Sysop can end the chat with the ESCAPE key. Through the Ctrl-A key is it possible to keep a capture file for later reviewing of the chat. | It is now possible to have a different yell tune for every | user and/or security level. This is done in the YELLTUNE.CTL | file. Here you specify for what securitylevel and/or what | users you want a different tune. The format of this ASCII file | is: | | Name/Security level Tune | Name/Security level Tune | | For example: | | Aki Antman AKITUNE.CTL | 2500 SEC2500.CTL | | In combination with the menu option to yell outside the spec- | ified page hours, this option allows your co-sysop for example | to allways page you and you would be able to hear from the | tune who it is. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 177 11.7 Alias system -------------------------------------------------------------- SuperBBS allows a full alias system. The Sysop can select the use of an alias in all message areas. (Most echomail areas don't allow aliases.) Mailcheck at logon or after a menu type 22 command, will be done for the user's real and alias name. No double aliases are allowed and SuperBBS checks this after a caller enters an alias. SuperBBS includes an option to view a list with real names and their aliases. The alias system only works if you set the option in the CONFIG.EXE program to Yes. 11.8 View a certain file -------------------------------------------------------------- An option in the user record is the field: File to view. Here you can specify per user a file which will be displayed to the user. You can select this file through the use of the SBBSUSER.EXE program. There is an option to allow the file to be deleted after viewing and only showing the file once. 11.9 Menu to run -------------------------------------------------------------- SuperBBS allows users to enter the system at another menu then the TOP.MNU menu. In the SBBSUSER.EXE program is a field for this option. Here you can enter the name of the menu the user wants to start at. SuperBBS will then pass the user directly to the menu given in the MenuToRun field. This menu can be different for every user. There is currently no automatic way to do this. You will have to adjust the userrecord yourself if you want this option available to your users. 11.10 Expiration system -------------------------------------------------------------- SuperBBS has an expiration system build in. There is a field in the SUSERS.BBS to store the date the expiration has to end. You could use this system to notify members of the expiration of their membership or something like that. When the date of expiration is reached and the user logs on again, he/she will see the questionnaire EXPIRED.Q-A, if available. In this file you can change the userlevel, flag- settings and other information. There is an option to add a certain amount of days to a new- user record. See the configuration part for more information. Two control codes are available to display the expiration date ^K# and the days till expiration ^F$. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 178 Chapter 12. Multitasking and multiline ============================================================== 12.1 General information -------------------------------------------------------------- SuperBBS is able of running a system with more lines. We ask everybody who uses SuperBBS to give their opinion and ideas. That way we can expand and improve the multi-node option. SuperBBS currently uses 250 KByte memory per line. The setup explained here is for a system running a multitasker like Desqview or a system using a network, although drive names could change in a network configuration. There is a special document available on running multiline systems. Please check your support BBS for this file. It is called: MULTI-SB.xxx (where xxx is the archiver). This docu- ment is by Bob Henderson and contains examples of running a system with Desqview. 12.2 Multiline configuration -------------------------------------------------------------- The directory setup for the multi-node operations is a bit different from the single line systems. You will have to make a directory for every node you plan to run, even if it's only a local node. Your directory setup could look like this: C:\SBBS C:\SBBS\LINE1 C:\SBBS\LINE2 C:\SBBS\LINE3 C:\SBBS\MAIL C:\SBBS\TEMP1 C:\SBBS\TEMP2 C:\SBBS\TEMP3 C:\SBBS\WORK1 C:\SBBS\WORK2 C:\SBBS\WORK3 C:\SBBS\NODELIST (Optional) C:\SBBS\ATTACH (Optional) E:\ Place the executable programs in the SBBS directory and set your path statement pointing to this directory. You will have to setup a TEMP directory and a WORK directory for every line in use. The E:\ drive is a RAM disk and is the common directory for all nodes. You can also use a normal disk if no RAM drive is available. But a RAM disk is faster. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 179 Go into the line1 directory and start the config.exe program. The configuration program will start and you can setup all information needed, including file areas and limits. After you have finished, you will find some configuration files in your line1 directory. If you plan to use one single file area configuration list and one single limits configuration list, move the FLSEARCH.CTL and LIMITS.CTL files to the main direc- tory. Their they are accessible by all different lines. Now enter the second line directory and run config again. An option is to copy all files from the line1 directory to the second, third..... directory and then change the settings in the config by running the configuration program. You will have to change at least the directory setup. If using one single FLSEARCH.CTL and LIMITS.CTL file (see above), delete these files created in the line2 and line3.... directories. Config will create the FLSEARCH.CTL and LIMITS.CTL everytime you access the Limits and file area part of the configuration. If you like to change something in the two files, you first have to move them to one of the line directories, otherwise the files are newly created. You will have to create a LANGUAGE.CTL file in every line directory. These can all be the same or can differ from line to line. The *.LNG files you use can all be placed in the main SuperBBS directory. You now have to create the menu and textfiles. This is done in the same way as with a single line, although there are some special points to watch. When using a type 7 exit, you will have to tell the external program which line it is using. Have a look at the type 7 optional data menu options for more information on this sub- ject. Most used command would be *N, telling the program which node it is running on. SuperBBS allows the use of the file DORINFO?.DEF, instead of the standard DORINFO1.DEF. The ques- tion mark will be replaced by the node number. When finished with the menus and textfiles, you can try the BBS by going into a line directory and entering BBS -L -N? (where the ? is the line number your working on). This will start the SuperBBS program in local mode on line?. You will now have to setup the multitakser, or the network software, to run the system multiline. Check your manual from the multitasker and/or network for more information on this subject. Please note that some external doors for SuperBBS can't handle the multiline setup. You might have to set up the program separately for every line. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 180 12.3 Multitaskers & networks -------------------------------------------------------------- SuperBBS has been tested with these multitaskers (All trade- marks of their respective owners): - Desqview 2.25 (Normal and 386 versions) - Desqview 2.31 - DoubleDos 4.0 - Windows 3.1 - OS/2 SuperBBS support multitasking with Desqview. It will release time slicks and SBBSUSER will ask from Desqview what memory to use for direct screen writes. SuperBBS has been tested with a Lantastic network, Novell Netware and a Novell Light network. Please make sure that when using a network, SuperBBS has the correct rights to read/write in the different directories. 12.4 Message base locking -------------------------------------------------------------- SuperBBS has a message base locking system. Information about this locking system is available on request from the SuperBBS headquarters for third party programmers. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 181 Chapter 13 External specific SuperBBS utilities ============================================================== 13.1 General information. -------------------------------------------------------------- SuperBBS comes with a few external programs. These are: - USERPACK.EXE - SBBSUSER.EXE - SBBSUTIL.EXE - SBBSMENU.EXE - STOP.EXE - SBBSNODE.EXE - SNETMGR.EXE - BOARD2CF.EXE These programs are specially written for the use with Super- BBS. Other programs are available, but do not always support all SuperBBS functions. 13.2 USERPACK.EXE -------------------------------------------------------------- This program is designed to clean your user database. It will delete all users from the USER.BBS and SUSER.BBS files who have the DELETE flag on. The only exception are user's with the NO-KILL flag on. It will also pack your userdatabase for faster processing. Userpack allows multiple commandline parameters, but all parameters are optional. These are the available options: Type.........: -B Description..: Makes backup of the user files. This will take the program longer to run than without this option. Type.........: -Dxxx Description..: Deletes users from the list who haven't called in xxx days. Type.........: -O Description..: Don't make backup copies if there is not enough diskspace. Use this command in combination with the -B option. Type.........: -R Description..: Removes backup copies after run is complete. Type.........: -Sxxx Description..: Deletes users with a securitylevel lower than xxx. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 182 Type.........: ? Description..: Gives a short help screen. Use only as single command line option. If you run userpack without any options, it will just pack your user base and delete every user with the DELETE flag on. 13.3 SBBSUSER.EXE -------------------------------------------------------------- This is the user editor for SuperBBS. You will be able to edit all available information in the user record. It is a full- screen program, with the function keys it uses displayed on the bottom line. Their are two modes (or windows). Edit mode and the main window. Edit mode allows you to change informa- tion from a caller. The main window is the command centre of the program. Here all function keys are active. From here you go to the edit window. These are the available keys: Key..........: Cursor keys Description..: Move around in the editmode of the program. This will move you from edit field to edit field. Key..........: Escape Description..: If in editing mode will ask you if you want to save the information and leave the edit mode. If in the main window, it will exit you to DOS. Key..........: Home Description..: Will move you to the first user when in the main window. Key..........: End Description..: Will move you to the last user when in the main window. Key..........: PgUp Description..: Will move you 10 users forward when in the main window. Key..........: PgDn Description..: Will move you 10 users backwards when in the main window. Key..........: F1 Description..: Display help screens for SBBSUSER. Key..........: F2 Description..: Goto general edit mode. This allows you to change most information available. Changing the security level fast is possible with the ALT-S option. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 183 Key..........: F3 Description..: Search for the user in the NEWUSER.ASW file and display his/her answers. Useful if you want to update users. Key..........: F4 Description..: Search option. This allows you to search for part of a name, alias, security level or city. Key..........: F5 Description..: Put current user in window in the TRASHCAN.CTL file. Key..........: F6 Description..: Add a new user to the database. Key..........: F7 Description..: Change the user's colour configuration. Key..........: F8 Description..: Change the user's flagsettings. Key..........: F9 Description..: Change the user's attributes. The delete flag can also be set from the main window through the ALT-D key. Key..........: F10 Description..: Exit the program. Key..........: Shift-F1 Description..: Add user to the VIP.CTL list. Key..........: Shift-F4 Description..: Change the number of calls | Key..........: Shift-F5 | Description..: Read any .ASW answer file With the numerical keys you can select an userrecord. Just enter the number of the record your looking for. SBBSUSER.EXE let's you edit the USER.BBS and SUSER.BBS file. Other user editors mostly allow only editing of the USER.BBS file. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 184 13.4 SBBSUTIL.EXE -------------------------------------------------------------- SBBSUTIL.EXE allows you to convert some SuperBBS files to general QuickBBS type files. This is useful for some external programs which can't handle the specific SuperBBS type files. The program also gives you the option to initialize your file directories. All commands are done through the use of command- line parameters. Start the program as follows: SBBSUTIL.EXE <parameter> The parameters are: Type.........: FLSEARCH Description..: Converts SuperBBS FLSEARCH.BBS to FLSEARCH.CTL, which can be used with RemoteAccess and/or QuickBBS utilities. Type.........: LIMITS Description..: Converts SuperBBS LIMITS.BBS to LIMITS.CTL. Type.........: INITFILEAREAS Description..: Will initialize all file areas listed in the file FLSEARCH.BBS. Here you can use three extra parameters: -F Make FILES.BBS files if not available. -D Make DIR.BBS files if not available. -A Add all missing files, files which are in the directory, but not in the FILES.BBS list, to the FILES.BBS list. Running the util program with the option: SBBSUTIL.EXE <parameter> ? will display a little help screen for the available options. | 13.5 USERSORT.EXE | -------------------------------------------------------------- | | This program has been completely rewritten by Pasi Talliniemi. | | Usersort is a utility to sort your userbase. This can be done | in several ways. The commandline is: | | USERSORT [<option><direction> <option><direction> .... ] | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 185 | The available options are: | | Option: Description: | ------------ --------------------------------------- | FIRST First name | LAST Last name | CITY City | SEC Security level | AGE Age of user | HIGHMSG Highest message read | MSGS Messages posted | CALLS Number of calls | DL-KB Downloaded files in Kilobytes | DL-TIMES Downloaded files in number of files | UL-KB Uploaded files in Kilobytes | UL-TIMES Uploaded files in number of files | | Every option can have a direction of sort given to the option. | By default the sort is done in ascending order. Directions: | | + Ascending order (default) | - Descending order | | Sysop is always placed at the beginning of the userlist. | Here is an example: | | USERSORT SEC- LAST+ FIRST+ | | This wil sort the userbase by security level in descending | order (from highest to lowest). If the security level is the | same the users are sorted on their lastname (from A to Z) and | if these are the same the sort of the same last name users is | done on their firstname (from A to Z). 13.6 SBBSMENU.EXE -------------------------------------------------------------- SuperBBS has it's own menu editor SBBSMENU.EXE. This is a complete menu editor for SuperBBS. It supports the multi- language aspects of SuperBBS. When you start the program, it should be in your directory containing the configuration files, you will be presented with the TOP.MNU menu if avail- able. Otherwise you will start in a new menu. Pressing [ESC] will display the menu. This menu has the fol- lowing options: Command......: Files Description..: Here you will be able to save, load, copy files and do other maintenance functions. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 186 Command......: Text Description..: Here you will find the options which work on the textpart of the menu. Command......: Commands Description..: Here you will find the options which work on the menu options from the menu. Command......: Prompt Description..: Commands for the prompt, which will be visible underneath the menu. Command......: Setup Description..: Setup commands for the menu editor. All menu commands will be described in detail below. 13.6.1 File commands -------------------------------------------------------------- Here are the commands you will find, when you enter the file menu of the SuperBBS menu editor. Command......: Load menu Description..: Loads a menu from the directory specified in the current language file. You will be pres- ented with a box stating what to look for. (Mostly *.MNU files.) Enter the value you want, or press ENTER and the editor will display a list of the available menus. With the cursor keys you can select a file. Pressing ENTER will load the file. Command......: Save menu Description..: Saves the menu you are currently working on. Command......: New menu Description..: Start building a new menu. The editor will ask you for a menu name. Command......: Write to Description..: Write the menu file to a specified name. This option is useful if you want to use a menu to build another. This way you can save a menu with a different name. Command......: Rename Description..: Rename a menu in the directory. The editor will ask you which menu to rename. Command......: Copy Description..: Copies a menu to another name. The editor will ask you for the name of the menu to copy. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 187 Command......: Language Description..: Changes the language currently in use. This allows you to quickly change menus for all languages, without leaving the editor. Command......: DOS Shell Description..: Shell temporarily to DOS. You need to type EXIT to return to the editor from DOS. Command......: Exit to DOS Description..: Exits the menu editor. 13.6.2 Text commands -------------------------------------------------------------- Please note that you now can use the ^Cxxx control code in the menu textfiles to make multicolored textlines. (xxx stands for the colour.) Command......: Edit text Description..: Change the text of the menu. Pressing ALT-F10 while in the text editor will display a help- file. Command......: Simulate text Description..: The editor will show you what your menu will look like if a user would see it. You will have to enter a security level and flagsetting. Command......: Clear text Description..: Clears the current text screen. Command......: View text Description..: View a text belonging to the menu. This option allows you to see files which are not part of the menu, but will be displayed through the ANSI/ASCII display file option in the menu. Command......: Run editor Description..: Enter an ANSI or ASCII text editor as you have described in the setup of the SuperBBS menu editor program. When you press ALT-F10 while you are in text edit, a help menu will be displayed. Here you will find all the commands avail- able to you. The use of extended ASCII characters is supported, so you can design lines and other graphics. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 188 13.6.3 Menu Commands -------------------------------------------------------------- This is the important part of the SuperBBS editor. Here you specify the menu commands. You will find the following com- mands in this menu: Command......: Edit menu Description..: Edit a menu file. Here you enter the menu type, securitylevel, hotkey and optional data. Command......: Text dump Description..: Dump the text to a printer. Command......: Menu dump Description..: Dump the menu information to a printer. When you press ALT-F10 while you are in menu edit, a help menu will be displayed. here you will find all the commands avail- able to you. Entering a menu is done through dialogue boxes for the menu type. If a menu type is not available in the menus given, you can use the option for 'other' menu types. 13.6.4 Prompt -------------------------------------------------------------- This menu option allows you to edit the prompt which is shown to the user. These commands are available: Command......: Edit prompt Description..: Change the text of the prompt. You can use control codes in the prompt if you want. Command......: Change colours Description..: Change the colours of the prompt. 13.6.5 Setup -------------------------------------------------------------- This option allows you to setup the menu editor. You can specify an ANSI and ASCII text editor and the default prompt. The text editors will be called if you want to edit a text- file, so make sure they are in your path, or you specified the complete name. 13.7 SBBSNODE.EXE -------------------------------------------------------------- As of version 1.15, SuperBBS has nodelist support build in. It isn't a 100 % yet, the cost aspect isn't supported yet, but it is working. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 189 Before you can use the nodelist with SuperBBS, you will need to compile two index files. This is done with the SBBSNODE.EXE program. This program will create the files NODEINC.SBS and NODEIDX.SBS. Make sure you have set the directory settings correctly in the configuration program. SBBSNODE.EXE can compile up to 10 different nodelists. It will automatically search for the NODELIST.??? file and compile it. You can give the other files to compile as extra commandline options. Here is an example: SBBSNODE SUPERNET SIGNODES This will compile the latest NODELIST.???, SUPERNET.??? and SIGNODES.??? nodelists. Run the nodelist program every time you update your nodelists. This is very important. 13.8 SNETMGR.EXE -------------------------------------------------------------- This program has two functions. One for multiline systems and one for all systems. When run for the first time, you will be prompted for an ASCII editor, like Q.EXE. If you ever want to change the editor, delete the SNETMGR.CFG file. | Included with SuperBBS v1.17 is a little program called | SNOOPER.COM. This program works together with SNETMGR.EXE. | With both programs you are able to monitor/use all remote work | stations from one computer. To use this new remote maintenance | system, you must load SNOOPER.COM on every workstation you are | going to use with SNETMGR.EXE. SNOOPER.COM only works in a | NETBIOS environment. 13.8.1 Users online -------------------------------------------------------------- This function of the SNETMGR.EXE program is only of use to multiline systems. It allows you to see the users online in every node, send messages to any combination of users or force any combination of nodes down with a selected errorlevel. The following keys are available: [CURSORKEYS] Move around the nodes [SPACE] Tag/untag node [S] Send message to node [D] Force node down with errorlevel -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 190 When forcing a node down, SNETMGR.EXE will ask you for the errorlevel to use to exit. ESCape will return you to the menu. Run the program from the line directories when you are running a multiline system. Otherwise the program will give the error- message that the file SCONFIG.BBS is not found. 13.8.2 Last callers -------------------------------------------------------------- The second option allows you to view the last 15 callers and today callers of your system. The program can also give you some information about the BPS rates used on your BBS. 13.9 BOARD2CF.EXE -------------------------------------------------------------- This file will place the message area information contained in the BOARDS.BBS file, into the CONFIG.BBS file, so programs not able to use the BOARDS.BBS file will still be able to read the configuration information they need. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 191 Chapter 14 Useful information ============================================================== | 14.1 Batchfiles | -------------------------------------------------------------- | | You can not run SuperBBS without a batchfile. Even when run- | ning SuperBBS alone, you will need a batchfile to restart | SuperBBS after a caller has logged off. | | Thanks to Bob Jackson, ETC MedNet in San Antonio, Texas, USA, | I have received some example of batchfiles to run SuperBBS. | The first examples are on running SuperBBS as a stand alone | system, the second with SuperBBS and Frontdoor, both examples | from Len Morgan, QST BBS, USA, and a third example from Bob | Jackson on how to run D'Bridge with SuperBBS. Thanks Bob! | | IMPORTANT: You MUST have some thing set in you autoexec.bat | for batch files and SuperBBS to work properly. In your | autoexec.bat file you must have set the environment variable: | | sbbs=<drive><path> | | This allows SuperBBS to find it's files like sbbsuser.exe, | usersort.exe, etc.. | | You must also have comspec set to cause the computer to | execute certain dos commands and read batch files. This is too | lengthly to explain here, you should read your dos manual on | Compsec. Simply put, it allows your computer to read batch | files and do certain dos commands. In the autoexec.bat file | this should read, set comspec=<drive><path to command.com>. | You can check if compsec is set by typing SET at the DOS | prompt. | | If you don't load your bbs with a batch file, several things | will happen. First, when your users exit, it will drop to dos | and die. Secondly, you will not be able to ESC from the call | waiting menu to drop to dos and unload your bbs program. | | Here is a simple batch file to load your bbs when you don't | use a Front End Mailer, typically Frontdoor or D'Bridge: | | @Echo off | | :Start | bbs.exe -P1 -E0 | | :Afterbbs | if errorlevel 2 goto end | goto start | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 192 | :End | Echo SuperBBS is down........ | @Echo off | | :Start | bbs.exe -P1 -E0 | | :Afterbbs | if errorlevel 2 goto end | goto start | | :End | Echo SuperBBS is down........ | | Explanation of some of the points in this batchfile: | | Line 1..: Turn off the echo so the computer doesn't show every | command in the batch file. | | Line 2..: This is called a "Label" and it MUST begin with a | Colon (:) to cause the computer to recognize it, not | as a command, but rather a beginning point to | execute other commands below it. | | Line 3..: Loads Superbbs. You must have this batch file in the | same directory as the bbs program, otherwise you | will need to CD\ before loading the bbs program. | The -P tells SuperBBS what port you are using and | the -E tells it to exit with an errorlevel of 0 if | all goes well. The -E0 can be userful to send the | computer to another label to do such things as | update the Best uploader, downloader file and | then send it back to start after that is done. | | Line 4..: Anoter Label to load errorlevels. | | Line 5..: When you either exit SuperBBS or use the ESC key in | local mode, SuperBBS will exit with an errorlevel | that is built into the bbs. There are 5 errorlevels | that it exits with and these MUST be reserved for | SuperBBS to use, so don't make an errorlevel below | 10. The explainations of errorlevels that SuperBBS | produces, is in this documentation. In this case | errorlevel 2 indicates that the sysop pressed the | ESC key. The errorlevel of 2 is invisibly transmit- | ted by SuperBBS and the "if errorlevel" looks to see | if it matches the number and if so, it will execute | the "goto" statment sending it to the designated | label to execute the very next command line in that | label In this case if I pressed ESC, Sbbs produces | an errorlevel of 2 and the "if errorlevel 2" sees > Continued > -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 193 | that it matches. It then exucutes the goto end and | sends it to the :End label, where it finds the | statement Echo, which causes it to display the very | next string of letters to the local screen (SuperBBS | is down....). | | Line 6..: If SuperBBS doesn't emit an errorlevel that is in | the "if errorlevel" command, it will completely | disregard the commands in the lines until it finds | another goto or executable statment. In this case, | if a user exits your bbs, it will exit with an er- | rorlevel of 0, meaning all went well. Since the | errorlevel of 0 isn't in the "if errorlevel" state- | ments it will drop down until it sees the "goto | start" statment and execute it. This will send it | back up the the label of Start, which will reload | the bbs for the next caller. | | That's it. Now you will be able to run SuperBBS in a simple | way. When you understand this, it is time to go a step further | and add a door (= external program) to SuperBBS. | | Now that you understand how a batch file works, now lets | expand on the above batch file and add a door. First you need | to understand that SuperBBS uses two ways to execute a door (a | program executed outside of SuperBBS). When you set up your | door from inside SuperBBS, you have two ways to call it up. | You can go into the SBBS Configuration file and go to "Doors". | This area is set up for programs that you want to appear in a | list of your doors from the built in screen of Sbbs. | | Many programs load with only the path and name of the program, | while others require secondary programs that need to be loaded | before the program, such as carrier detect and fossil pro- | grams. These programs can be loaded from the "door" command | line of the SuperBBS configuration file, by simply executing | them like this, assuming they are in the Sbbs directory: | | Nodedoor.exe | | Otherwise you will have to put a path statment in front of it | to locate the file, like this: | | c:\door\nodedoor\nodedoor.exe. | | You can use the "door" line to load batch files that require | more than just a simple command line to run them. You must | tell dos that you want to execute the command.com and what | path to find it. This is done with the *C /c commands. The *C | tells the computer where to find the command.com file, which | you specified in the set comspec=c:\command.com from your | autoexec.bat file. The /c tells it to execute a batch file. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 194 | Your line should look like this: | | *C /c myfile.bat | | It can then have something called switches. You will find | these elsewhere in this SuperBBS document, however, a quick | overview of some of them are: | | *F = First Name | *L = Last Name | *B = Baud rate | *G = If user is using graphics | *T = Time user has left on the bbs | *S = Swap Sbbs to disk first. | | The above batch load command should look like this: | | *C /c myfile.bat *F *L *B *G *T *S. | | These "switches" cause the dorinfo1.def to contain the infor- | mation you specify with the * switches. Many pieces of infor- | mation in the dorinfo1.def is automatic, this just assures | that the basic information gets passed to the dorinfo1.def | file. | | The second use of SuperBBS is more complex and requires you to | load the door from the menu you have made. These are called a | type 7 or 15 commands. A type 7 will load just like a type 15, | however, it will not swap SuperBBS to dos to make room for the | program, unless you use the *S switch. More on this later. | The type 15 command will swap to disk and is more usefull to | save valuable memory. | | The type 7 command is defined on the "TYPE" command line of | your menu and the paramaters to load the program or bat file | are put on the DATA line of the menu. | | If I want to load a type 7 to load a batch file called | myfile.bat, I would put: | | *C /c myfile.bat *F *L *B *G *T *S | | in the DATA field of my menu and 7 in the TYPE field. Notice | I didn't use a path statment in front of the myfile.bat, this | means the program will be found in the SBBS directory, other- | wise, I would have to put a path in like this: | | *C /c c:\door\myfile\myfile.bat *F *L *B *G *T *S. | | The only problem with this is if the program doesn't have a | configuration file to specify where to find the dorinfo1.def | or a path after executing it (myfile.exe c:\sbbs\dorinfo1.def) | then I would have to enclude a copy command in the batch file -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 195 | to copy the dorinfo1.def to the directory of the door. Here is | a sample type 7 batch file to load a carrier detect program, | copy the dorinfo1.def, the program, then exit back to Sbbs: | | Echo off | cd\door\myfile | watchcd on | copy c:\sbbs\dorinfo1.def | myfile.exe | watchcd off | cd\sbbs | exit | | When you use a type 15, to save memory, it will be different, | becasue it uses an errorlevel to exit the bbs. | | In the Menu DATA field you would assign a number to use for | loading the program. Let us pick 100 as the number. In the | TYPE field you would use 15 to indicate that this is an error- | level exit. | | Now the program will return back to your batch file that | loaded the bbs to execute the errorlevel 100. Here is the look | of the batch file with this new errorlevel: | | @Echo off | | :Start | bbs -P1 -E0 | goto afterbbs | | :Restart | cd\sbbs | bbs -R -P1 -E0 | | :Afterbbs | if errorlevel 100 goto myfile | if errorlevel 2 goto end | goto start | | :Myfile | cd\door\myfile | watchcd on | copy c:\sbbs\dorinfo1.def | myfile.exe | watchcd off | cd\sbbs | goto restart | | :End | Echo SuperBBS is down........ | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 196 | You will now notice some new parts to the old batch file. | These areas had to be added: The label Restart, goto restart, | and the use of the -R switch after reloading bbs.exe. | | Here is what happens how. You load the batch file and bbs.exe | loads and the program waits for a call. A call comes in and | the user logs on. They then execute the key for the type 15 | command to load myfile.exe with an errorlevel of 100. The | computer leaves bbs.exe, goes to :Afterbbs and looks for the | errorlevel of 100. It follows the directions and goes to | :Myfile and loads the subsequent lines in that label. The user | exits the myfile.exe program and the computer continues to | follow the batch file until it sees "goto restart". This sends | it back to the second bbs.exe with the -R for restarting the | bbs. The bbs then loads again and returns the user to where | they were when they pressed the key to load myfile.exe. The | user logs off and SuperBBS exits with an errorlevel of 0 as | indicated by the -E0. The next line in :Restart, after un- | loading the bbs.exe -R, doesn't have a "goto" line, so it | drops directly into the next label (:Afterbbs), looks for | errorlevel of 0 and not finding it goes to the line "goto | start", then executes it and reloads the bbs. | | You can now add as many errorlevels as you want with a type | 15. When you learn enough to run a FIDO mail board, you will | use other preset errorlevels like 3,4 and 5. These will tell | Superbbs that you entered Netmail (3), Echomail (4), or both | Echomail and Netmail (5). You will then have to learn how to | use external programs to process the messages left with these | levels. | | Now for the examples on running SuperBBS with a mailer pro- | gram. First an example on Frontdoor and SuperBBS. Again by | Len Morgan, just as the example above. | | There are two ways of loading SuperBBS, when a Mailer is being | used to answer the phone. In this file, we will discuss the | EXITING method of loading your bbs. The advantage of using the | EXIT method of loading, is that it uses less memory to run the | bbs and other programs, however, this method runs slower than | the second method called SPAWNING (See Spawnbat.txt). | | I will assume that you understand batch file language and | commands. | | With the many different mailer programs such as Frontdoor, | D'Bridge, Bindkley, etc., I cannot tell you how to cause your | mailer to exit with a method of passing certain parameters to | SuperBBS, however, I do know that Frontdoor uses errorlevels | for the baud rates from inside it's setup, as an example, 300 | baud is errorlevel 255, 1200 baud is 254, etc.. | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 197 | With D'bridge, the baud rate is passed to the bbs program by a | simple formula of, baud rate divided by 10 = errorlevel. So | 2400 / 10 = 24. In this case the errorlevel 24 means 2400 | baud. | | When SuperBBS is loaded you can use the "if errorlevel" to | find the baud rate. For example when using Frontdoor, if | errorlevel 253 goto 2400, would cause the batch file to see if | the errorlevel of the caller was 2400 baud and if so, pass the | caller to the 2400 label and load the bbs, simularly, if | D'Bridge is used, then the "if errorlevel 24 go to 2400", | label would work. | | We will have a look at the example of the NNN SuperBBS batch- | file. Here's the batchfile, afterwards Len will add some of | his comments to it: First the CD-Rom is tested. This makes sure the CD-Rom will be available when called upon from SuperBBS. Then Frontdoor is started. Depending on the errorlevel of the exit from Front- door, will the BBS be started or an event will be executed. Errorlevels 117 to 124 represent the different modemspeeds. These errorlevels are set in the configuration program of Frontdoor. Errorlevel 116 is a local logon, executed through the use of a function key in Frontdoor. Errorlevel 110 is executed when it is time for the event, mostly run in the early hours of the day. Errorlevel 125 is used when mail is received by Frontdoor. The system is using two different limits.ctl files, one for the hours between 18:00 and 24:00 hours and one for the other time period. They are copied at two events in Frontdoor, errorlevel 105 and 104. The second part in this batchfile with errorlevels is the part where SuperBBS will exit to after a type 15 exit and after the user logged off. Depending on the errorlevel a certain action is taken. If the user logged of, Frontdoor will be started again. If it was a type 15 exit, an external program is started. After the external program SuperBBS will restart with the -R option and again return to the errorlevel part when the user logged off, or used another type 15 exit. rem Batchfile NNN SuperBBS - may 1991 rem Last revised: 12-06-91 @echo off :cdrom dir d:\ :start cd\fd fd.exe -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 198 if errorlevel 125 goto mail if errorlevel 124 goto 38400bps if errorlevel 123 goto 19200bps if errorlevel 122 goto 16800bps if errorlevel 121 goto 14400bps if errorlevel 120 goto 12000bps if errorlevel 119 goto 9600bps if errorlevel 118 goto 4800bps if errorlevel 117 goto 2400bps if errorlevel 116 goto 1200bps if errorlevel 115 goto local if errorlevel 110 goto maint if errorlevel 105 goto avond if errorlevel 104 goto dag if errorlevel 10 goto end if errorlevel 1 goto error goto end :38400bps cd\superbbs\line1 bbs -N1 -B38400 goto afterbbs :19200bps cd\superbbs\line1 bbs -N1 -B19200 goto afterbbs :16800bps cd\superbbs\line1 bbs -N1 -B16800 goto afterbbs :14400bps cd\superbbs\line1 bbs -N1 -B14400 goto afterbbs :12000bps cd\superbbs\line1 bbs -N1 -B12000 goto afterbbs :9600bps cd\bbs\line1 bbs -N1 -B9600 goto afterbbs :7200bps cd\bbs\line1 bbs -N1 -B7200 goto afterbbs -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 199 :4800bps cd\bbs\line1 bbs -N1 -B4800 goto afterbbs :2400bps cd\bbs\line1 bbs -N1 -B2400 goto afterbbs :1200bps cd\bbs\line1 bbs -N1 -B1200 goto afterbbs :local cd\bbs\line1 bbs -l -N1 goto afterbbs :mail echo ath1 > com2 gecho toss mbutil link goto start :dag cd \superbbs copy tijd1.bbs limits.bbs goto start :avond cd \superbbs copy tijd2.bbs limits.bbs goto start :maint echo ath1 > com2 cd\superbbs copy users.bbs users.fh copy susers.bbs susers.fh mbutil purge -file mbutil.bbs mbutil index -renumber -delete mbutil pack -renumber -overwrite mbutil link userpack -D90 -S5 fast /s maf copy \superbbs\line1\config.bbs \superbbs\config.bbs dbest c:\superbbs\text\top-uplf NNN_SuperBBS 200 u25 dbest c:\superbbs\text\top-dowf NNN_SuperBBS 200 d25 dbest c:\superbbs\text\top-uplk NNN_SuperBBS 200 r25 dbest c:\superbbs\text\top-dowk NNN_SuperBBS 200 s25 -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 200 dbest c:\superbbs\text\top-call NNN_SuperBBS 200 c25 dbest c:\superbbs\text\top-mess NNN_SuperBBS 200 m25 dbest c:\superbbs\text\top-area NNN_SuperBBS 200 b25 dbest c:\superbbs\text\top-syst NNN_SuperBBS 200 i delete \superbbs\config.bbs boot goto start :afterbbs if errorlevel 250 goto start if errorlevel 152 goto upload if errorlevel 151 goto download if errorlevel 150 goto xpress if errorlevel 5 goto both if errorlevel 4 goto echomail if errorlevel 3 goto netmail if errorlevel 1 goto end goto start :restartbbs cd\superbbs\line1 bbs -R -N1 goto afterbbs :both echo ath1 > com2 gecho scan pack goto start :echomail echo ath1 > com2 gecho scan pack goto start :netmail echo ath1 > com2 gecho scan pack goto start :xpress cd\xpress xpmail -P2 -F -B38400 -DISF -NC goto restartbbs :upload cd\xpress xpmail -P2 -F -B38400 -DISF -NC -U goto restartbbs :download cd\xpress xpmail -P2 -F -B38400 -DISF -NC -DAP goto restartbbs -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 201 :error echo Systeem error !! :end echo ath1 > com2 echo NNN SuperBBS down. | That's the batchfile, now for an explanation on some of the | parts.... | | @Echo off: | | In this example the first line turns off the echo so the | commands don't appear on the screen. The @ only works in DOS | 3.3 and hiogher and prevents the line Echo off to be dis- | played. If you use a DOS version before 3.3 upgrade now or | leave the @ off. | | :cdrom | dir d:\ | | This line is used if you have a cd\rom for storing overlays or | files on. It makes sure the CD-Rom is available to SuperBBS. | Microsoft recommends to do a DIR command to the CD-Rom player | before starting a program which uses the CD-Rom player. It is | normally not used. | | :start | cd\fd | fd.exe | | This loads the Frontdoor mailer. | | "if errorlevel 125 goto mail" | | This begins the process of trapping the errorlevel created by | the Mailer. In this case, the first errorlevel of 125, is | looking to see if mail came in, and if so, it executes a mail | tosser program. | | Finally, we come to the errorlevel of 124, which would trap a | users baud rate of 38400. It would then look for the goto | statement and execute it. In this case it is "goto 38400bps", | which is the name of the label it goes to. | | Follow down the batch file until you find :38400bps, you will | see that this label loads the bbs with a -N1 -B38400. The N1, | is telling Superbbs that it is operating on line 1, of a | multiline system. If you don't run a multiline system then you | don't need to change directories to cd\superbbs\line1. Instead | you would cd\sbbs and then load bbs.exe like this: | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 202 | :38400bps | cd\superbbs | bbs -B38400 -E0 | goto afterbbs | | In this case, I added the -E0 to tell Superbbs to exit with an | errorlevel of 0, if all goes well. The "if errorlevel 0" can | be used to run another program before it reloads the bbs. The | "goto afterbbs", at the end of the :38400bps label, is sending | it to another errorlevel checker, that traps errorlevels of | SuperBBS, look for :Afterbbs. Unlike the errorlevels created | by the mailer, these new errorlevels work on errorlevels | passed from SuperBBS, when it exits from the bbs to load | files. | | :Afterbbs | | When the user exits SuperBBS, a new errorlevel is created and | the :Afterbbs label is loaded. The trap looks for any of the | errorlevels created by Sbbs, if found causes the computer to | follow the goto statment to the label indicated. | | In the label :Afterbbs, you will see errorlevel 250. This | errorlevel sends the computer right back to the :start and | reloads the mailer of fd.exe. In errorlevel 1 the label says, | goto end. Follow this to the label :End, you will see echo | ath1 > com2 then echo NNN SuperBBS down.... | | This label causes the comport 2 to take the phone off the hook | and echo the string Node 2 SuperBBS down.... to the screen. | This means that something went wrong and SuperBBS gave the | errorlevel of 1 to the batchfile. Remember, errorlevel 0, | means that all went well, so errorlevel of 1 means that there | was a failure somewhere in the execution of Sbbs. The 1 got | trapped in the "if errorlevel statment" and it followed the | direction to goto label End. | | Don't be alarmed if you don't see the if errorlevel 0, in the | batch file. It is usually understood that if all the errorle- | vels that Superbbs defaults to when in trouble or processing | mail (errorlevels 1-5) don't match, then 0 is assumed and it | passes to the last line in the :Afterbbs trap to the "goto | start", which sends it right back up top and loads the mailer | again. | | If you add the -P*P or -T*T switch to load Superbbs, it will | look for the Port and Time to the next event that can be | passed by your mailer. This way, you can specify different | ports and the remaining time, so a user dosen't over stay his | time and the mailer can execute a scheduled event like a | routine to clean the bbs at midnight. This way, you won't have | to activate the EVENTS in superBBS to kick off the user. I -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 203 | recommend that you activate them anyway as a security in case | the mailer and SuperBBS are not passing the time and port. I | have seen mailers fail to pass the time and allow users online | past midnight. This causes SuperBBS to leave that user with | time left from the previous day, instead of resetting them to | a new time limit for a new day. The *P and *T simply passes | the port and time from the mailer which should be hidden and | can be trapped with the *P and *T switches. | | To add an errorlevel to the batch file for loading a door, | only requires you to add it to the right trap. Remember there | are two errorlevel traps. One for the mailer and the other for | the bbs. Add the door to the :Afterbbs trap sending it to a | new label. Remember also, when the label has been run, you | must either reload the bbs or restart the mailer. On a game | door, you will want to send the user back to the bbs. To do | this you will need a label of :restartbbs, or such simular | name. | | Look at the :Afterbbs trap and you will see errorlevel 150. | This sends the bbs to xpress. :Xpress will load an outside | program (xpmail) and when done, it allows the computer to drop | into the goto restartbbs line. This line loads the label | :restartbbs, which in turn loads the bbs with a -R switch. | This tells Superbbs that this isn't the first time the bbs was | loaded and to restart the bbs. | | I hope you are beginning to catch on now. | | This is to show you how to use the SPAWNING method of making a | batch file. | | SPAWNING method requires more memory, however, it operates | much faster and once you get the hang of it, you won't have a | problem. Even though it takes more memory, I have used it | without any problems on a 640k RAM systems for years. | | | What is spawning? If you think of two fish, who find each | other, spawn and make an off spring, then you will understand | the spawn method. One batch file spawns a second batch file, | that will load the third batch file. | | If you run Frontdoor, in the configuration program you find an | option about creating a batch file. You will need to answer | YES to this question as well as assign an errorlevel to be | trapped. Let's use errorlevel 200. You will also have to give | a name of the file that the spawn will load. In this case, we | are going to call it EXEBBS.BAT and you will have to find | where in Frontdoor to give it the name of this file. It has | been too long since I have run Frontdoor. | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 204 | In this second batch file called DOBBS or SBBS, includes four | paramaters: | | 1) The name of the third batch file to be loaded. | 2) The baud rate. | 3) The port being used. | 4) The time to next event. | | Note that Frontdoor 2.01 has a problem with the event | time on some BPS rates. Use 2.02 instead. | | All this will be waiting to be trapped by the third batch file | that loads your bbs called EXEBBS.BAT. When using Frontdoor | this DOBBS.BAT file is automatically made and named dobbs.bat, | as long as you have the "Create batch" on in the FD config. | | For simplicity sake, we will call the first batch file, that | loads your Frontdoor or D'Bridge Mailer, RUNFD.BAT. This file | loads the bbs and can look something like this: | | @echo off | :start | d: | cd \fd | fd | if errorlevel 200 goto loadbbs | if errorlevel 189 goto clean | if errorlevel 188 goto normal_routing | goto end | | :loadbbs | sbbs.bat | | :clean | cd\sbbs | mbutil purge -file mbutil.pur | mbutil pack -force -delete -recover | mbutil sort -pack | mbutil link | goto start | | :normal_routing | cd\sbbs | stop d:\sbbs\txtfiles\best u10 d10 c10 m10 b10 | userpack -d60 | usersort sec- last+ first+ | goto start | | :end | Echo Frontdoor is down.... | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 205 | When the Mailer exited, it created a batch file called | DOBBS.BAT for Frontdoor. The mailer then exits with an error- | level of 200 and is trapped by the "if errorlevel 200 goto | loadbbs" line of the trap. The batch file sees the 200, | executes and drops to a label called :loadbbs. It then | executes the "spawned" batch file called either dobbs.bat or | sbbs.bat. | | Below is the EXEBBS.BAT file that loads your bbs: | | rem exebbs.bat to load the bbs | echo off | if %1==local goto local_sbbs | cd\sbbs | bbs -B%1 -P%2 -T%3 -E0 | goto after_sbbs | | :restart_sbbs | cd\sbbs | bbs -R -E0 | goto after_sbbs | | :after_sbbs | if errorlevel 60 goto ava | if errorlevel 5 goto finish | if errorlevel 4 goto finish | if errorlevel 3 goto netmail | if errorlevel 2 goto finish | if errorlevel 1 goto end | if errorlevel 0 goto finish | goto out | | :netmail | cd\sbbs | mbutil export snetmail d:\db\mail | cd\sbbs | goto finish | | :ava | d: | cd\ava | ava ava.cfg d:\sbbs\ | cd\sbbs | goto restart_sbbs | | :local_sbbs | cd\sbbs | d:\sbbs | bbs -L -E0 | if errorlevel 3 go to netmail | goto finish | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 206 | :finish | cd\fd | runfd | | :out | Echo SuperBBS is down..... | | The %1 is used to check and see if the bbs is being loaded | locally. This is also a trap and it will look at the spawned | batch file to see if there is a word of "local" instead of a | baud rate. If so, it goes to a local label. If not, it drops | down and loads the bbs with: | | BBS B%1 P%2 T%3 -E0. | | Let's refresh this procedure once more. The RUNFD.BAT loaded | the mailer. A call came in and it was determined by the mailer | that it was as human and spawned the file DOBBS. The computer | went to the label ":loadbbs", then dropped into the DOBBS.BAT. | Inside this batch file it told the computer to load a program | called EXEBBS (.bat extension assumed), and it carried the | baud rate of the caller, comm port, and time remaining. Here | is what the DOBBS looked like inside of it: | | EXEBBS 14400 1 67 | | This is an actual spawned batch file called sbbs.bat from my | bbs. The first word is the name of the batch file it is to | load. The second is the baud rate of the caller, the next is | the com port, and the last is the time this user has before | the next event for the mailer. | | The % sign after the -B,-P, and -T switches puts the numbers | in for the baud rate, port and time. In the above example the | -B%1 loads the first numeric value of 14400 as the baud | rate, -P%2 loads the second numeric value of 1 for the port, | and the -T%3 load the third numeric value of 67 for the min- | utes until the next event. | | The last line in the after loading the bbs is, goto after_sbbs | which sends the bbs to the trap for any doors. | | If you will notice in :After_sbbs, the errorlevel of 60 sends | the computer to another label called :Ava, which loads my call | back verifier and when done sends the user back to the bbs | with the "goto restart_sbbs" by reloading the bbs with the -R | switch. This tells Sbbs that is is being reloaded and to pass | the caller back to bbs without doing a complete reload. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 207 | In this example, unlike my other batch files, I used the if | errorlevel 0, instead of assuming it and allowing it to pass | to the goto line at the end. This time I don't want it to pass | to the last line (goto out), since that will send it to a | label called :End, that will end the batch file and I don't | want to do that. | | The greatest difference between EXITING and SPAWNING is that, | the latter method eliminates all the need for each baud rate | that might come in. When you run a 2400 baud modem this isn't | so significant, however, when you run 14400 baud this can | present a lot of work and more of a chance of error. | | The EXITING method only requires one batch file to do both the | mailer and the bbs, whereas, the SPAWNING method requires two. | | I much prefer the SPAWNING method and have used it successful- | ly for many years now. It runs quick and makes looking at the | bbs batch file easier than looking at both crammed into one. | That confuses me and I can't afford that, I'm confused easily | enough. :-) | | I hope this has helped you. If you need any assistance, let | me know. | | Information by: Len Morgan | QST BBS | SuperBBS Western U.S. Sup./Reg./Beta Site | FidoNet: 1:203/730 | (916) 920-1288 | | Here are two complete examples of the RUNFD.BAT and EXEBBS.BAT | files. If you need more info, contact the Support sites. | | ----------------------- | Example of RUNFD.BAT | ----------------------- | | ECHO OFF | :LOOP | CD\FD | FD.EXE | IF ERRORLEVEL 255 GOTO BBS | IF ERRORLEVEL 254 GOTO BBS | IF ERRORLEVEL 253 GOTO BBS | IF ERRORLEVEL 200 GOTO MAILIN | IF ERRORLEVEL 199 GOTO LOCAL_BBS | IF ERRORLEVEL 198 GOTO QD3 | IF ERRORLEVEL 197 GOTO BBS_CONFIG | IF ERRORLEVEL 196 GOTO L_CONFIG | IF ERRORLEVEL 195 GOTO Q_EDIT | IF ERRORLEVEL 194 GOTO USER_EDIT | IF ERRORLEVEL 193 GOTO MM -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 208 | IF ERRORLEVEL 192 GOTO FMAIL_SETUP | IF ERRORLEVEL 191 GOTO FFAM | IF ERRORLEVEL 190 GOTO BBSMENU | IF ERRORLEVEL 165 GOTO TICK | IF ERRORLEVEL 150 GOTO CLEAN_1 | IF ERRORLEVEL 149 GOTO CLEAN_2 | IF ERRORLEVEL 148 GOTO NODE | IF ERRORLEVEL 147 GOTO SUTILFREQ | GOTO END | | :BBS | DOBBS | GOTO LOOP | | :MAILIN | CD\SBBS | FMAIL TOSS | GOTO LOOP | | :LOCAL_BBS | C:\COMMAND.COM /C EXEBBS.BAT LOCAL | GOTO LOOP | | :QD3 | QD3.EXE | GOTO LOOP | | :BBS_CONFIG | CD\SBBS | CONFIG.EXE | GOTO LOOP | | :L_CONFIG | CD\SBBS | LCONFIG.EXE | GOTO LOOP | | :Q_EDIT | Q.EXE | GOTO LOOP | | :USER_EDIT | CD\SBBS | SBBSUSER.EXE | GOTO LOOP | | :MM | CD\SBBS | MM.EXE | GOTO LOOP | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 209 | :FMAIL_SETUP | CD\SBBS | FSETUP.EXE | GOTO LOOP | | :FFAM | CD\SBBS | FIDO-FAM FLSEARCH.CTL z l | GOTO LOOP | | :BBSMENU | CD\SBBS | SBBSMENU.EXE | GOTO LOOP | | :CLEAN_1 | CD\UTIL | FILESORT.EXE | RMBAK.EXE | CD\SBBS\HOLIDAY | HOLIBBS.EXE | CD\SBBS | FMAIL SCAN /S | FMAIL TOSS | FMAIL PACK /C /H /O | FTOOLS MAINT /D /N | FTOOLS MAINT /P | USERPACK -D60 | STOP TOP10 b10 t10 c10 d10 u10 m10 i | GOTO LOOP | | :CLEAN_2 | CD\AVL | AVAILIST.EXE | CD\SBBS | SUTIL DATEFILE \SBBS\SYSTEM.LOG | CD\FD | SUTIL DATEFILE \FD\FD.LOG | GOTO LOOP | | :NODE | CD\FD\FILES | IF NOT EXIST NODEDIFF.* GOTO LOOP | spaz NODEDIFF.* C:\FD\NODE | DEL NODEDIFF.* | CD\FD\NODE | XLAXDIFF.EXE | FDNC /F | CD\SBBS | SBBSNODE.EXE | GOTO LOOP | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 210 | REM :SUTILFREQ | REM CD\SBBS | REM CALL MAKEFREQ.BAT | REM GOTO LOOP | | :TICK | CD\FD | TICK.EXE > TICK.LOG | GOTO LOOP | | :END | | | | ------------------------ | Example of EXEBBS.BAT | ------------------------ | | ECHO OFF | CD\SBBS | IF %1==LOCAL GOTO LOCAL_BBS | BBS -B%1 -P%2 -T%3 -E0 | GOTO AFTER_BBS | | :RESTART_BBS | CD\SBBS | BBS -R -E0 | GOTO AFTER_BBS | | :AFTER_BBS | IF ERRORLEVEL 50 GOTO OUTSIDE | IF ERRORLEVEL 5 GOTO MAILOUT | IF ERRORLEVEL 4 GOTO MAILOUT | IF ERRORLEVEL 3 GOTO MAILOUT | GOTO OUT | | :LOCAL_BBS | CD .. | CD\SBBS | BBS -L -E0 | GOTO AFTER_BBS | | :OUTSIDE | CTTY GATE1 ON | COMMAND.COM | CTTY CON | GOTO RESTART_BBS | | :MAILOUT | CD\SBBS | FMAIL SCAN /S | FMAIL PACK /C /O | GOTO OUT -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 211 | :OUT | CD\FD | RUNFD.BAT | | Here's an example of running a system with D'Bridge as a | mailer. This example is supplied by Bob Jackson, ETC MedNet. | Also included are the AUTOEXEC.BAT and CONFIG.BAT files: | | ** AUTOEXEC.BAT ** | | @ECHO OFF | PROMPT $e[1;44;37m∙$e[0m$e[41m▀▀▀$e[0m $p$g | PATH=C:\;C:\DOS;c:\stacker;C:\TOOLS;C:\TOOLS\BIN;C:\TOOLS\CP7; | d:\;e:\;f:\;f:\DB;f:\;f:\COMMO;f:\SBBS;f:\SBBS\SUTL SET PCTOO- | LS=C:\TOOLS\CP7 | set ra=f:\sbbs | set dbridge=f:\db | set db=f:\db | set dbq=f:\db\dbutl\dbqueue.cfg | set db-swapfn=c:\zdir\dbswap.$$$ | set tz=est6edt | set golded=f:\db\gold | set tic=f:\db\dbutl\tic.cfg | set mbu=f:\db\dbutl\mbutil.ctl | set diskstats=y | set sbbs=f:\sbbs | set superbbs=f:\sbbs | set sutil=f:\sbbs | set pcplus=f:\commo\pcp | set dsz=f:\commo | set dszport=4 | set dszopt=mr8g | set dszlog=f:\logs\dsz.log | set dirrx=f:\db\files\ | set comspec=c:\dos\command.com | set x=go | loadhigh c:\stacker\stacker.com | pc-cache.com /sizexp=512 /If /Ig | rem MIRROR C: D: E: | rem BNU /T:2048 /R:2048 /L:3=38400 /F+ | RUNDB | | ** CONFIG.SYS ** | | buffers=30 | stacks=0,0 | files=50 | device=c:\dmdrvr.bin | device=c:\dos\himem.sys | dos=high | device=c:\ems40.sys | device=c:\dos\ansi.sys | devicehigh=c:\gmouse.sys -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 212 | rem devicehigh=c:\dos\ramdrive.sys 512 /e | rem ------------------------------------[Fossil]----- | devicehigh=c:\x00.sys B,3,38400 | rem devicehigh=C:\BNU.SYS /T:2048 /R:2048 /L:3=38400 /F+ | rem --------------------------------------[END]------ | break=on | DEVICEhigh=c:\stacker\STACKER.COM /EMS F:\STACVOL.DSK | DEVICEhigh=C:\STACKER\SSWAP.COM F:\STACVOL.DSK | | ** RUNBBS.BAT ** | | @ECHO OFF | :START | | F: | CD\DB | | rem ----------------FOSSIL---- | XU CAPTURE:OFF | rem BNU /Q | rem ----------------FOSSIL---- | | DB | | IF ERRORLEVEL 250 GOTO INIT | IF ERRORLEVEL 160 GOTO START | IF ERRORLEVEL 157 GOTO WKLYMNT | IF ERRORLEVEL 156 GOTO BKUPMSG | IF ERRORLEVEL 155 GOTO BKUP-C-D-E | IF ERRORLEVEL 154 GOTO BKUP-F | IF ERRORLEVEL 153 GOTO CRIT | IF ERRORLEVEL 152 GOTO IMPORT | IF ERRORLEVEL 151 GOTO UNPACK | IF ERRORLEVEL 150 GOTO CLEAN | IF ERRORLEVEL 145 GOTO FAX | IF ERRORLEVEL 144 GOTO 14400 | IF ERRORLEVEL 96 GOTO 9600 | IF ERRORLEVEL 48 GOTO 4800 | IF ERRORLEVEL 24 GOTO 2400 | IF ERRORLEVEL 12 GOTO 1200 | IF ERRORLEVEL 3 GOTO 300 | IF ERRORLEVEL 1 GOTO LOCAL | IF ERRORLEVEL 0 CLS | WAIT 1 | rem ECHO ATH0 >COM4 | go | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 213 | :INIT | ECHO ON | ECHO ATH0M1L3 >COM4 | WAIT 5 | ECHO ATZ | WAIT 5 | ECHO OFF | | GOTO START | | :14400 | rem BNU /C | XU CAPTURE:ON | F: | CD\SBBS | BBS -b14400 -e0 | IF ERRORLEVEL 100 GOTO START | rem IF ERRORLEVEL 25 GOTO | IF ERRORLEVEL 24 GOTO BID | IF ERRORLEVEL 20 GOTO RETURN | IF ERRORLEVEL 10 GOTO CBV | IF ERRORLEVEL 5 GOTO NET/ECHO | IF ERRORLEVEL 4 GOTO ECHOMAIL | IF ERRORLEVEL 3 GOTO NETMAIL | GOTO START | | :9600 | rem BNU /C | XU CAPTURE:ON | F: | CD\SBBS | BBS -b9600 -e0 | IF ERRORLEVEL 100 GOTO START | rem IF ERRORLEVEL 25 GOTO | IF ERRORLEVEL 24 GOTO BID | IF ERRORLEVEL 20 GOTO RETURN | IF ERRORLEVEL 10 GOTO CBV | IF ERRORLEVEL 5 GOTO NET/ECHO | IF ERRORLEVEL 4 GOTO ECHOMAIL | IF ERRORLEVEL 3 GOTO NETMAIL | GOTO START | | :4800 | rem BNU /C | XU CAPTURE:ON | F: | CD\SBBS | BBS -b4800 -e0 | IF ERRORLEVEL 100 GOTO START | rem IF ERRORLEVEL 25 GOTO | IF ERRORLEVEL 24 GOTO BID | IF ERRORLEVEL 20 GOTO RETURN -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 214 | IF ERRORLEVEL 10 GOTO CBV | IF ERRORLEVEL 5 GOTO NET/ECHO | IF ERRORLEVEL 4 GOTO ECHOMAIL | IF ERRORLEVEL 3 GOTO NETMAIL | GOTO START | | :2400 | rem BNU /C | XU CAPTURE:ON | F: | CD\SBBS | BBS -b2400 -e0 | IF ERRORLEVEL 100 GOTO START | rem IF ERRORLEVEL 25 GOTO | IF ERRORLEVEL 24 GOTO BID | IF ERRORLEVEL 20 GOTO RETURN | IF ERRORLEVEL 10 GOTO CBV | IF ERRORLEVEL 5 GOTO NET/ECHO | IF ERRORLEVEL 4 GOTO ECHOMAIL | IF ERRORLEVEL 3 GOTO NETMAIL | GOTO START | | :1200 | rem BNU /C | XU CAPTURE:ON | F: | CD\SBBS | BBS -b1200 -e0 | IF ERRORLEVEL 100 GOTO START | IF ERRORLEVEL 24 GOTO BID | IF ERRORLEVEL 10 GOTO CBV | IF ERRORLEVEL 5 GOTO NET/ECHO | IF ERRORLEVEL 4 GOTO ECHOMAIL | IF ERRORLEVEL 3 GOTO NETMAIL | GOTO START | | :300 | rem BNU /C | XU CAPTURE:ON | F: | CD\SBBS | BBS -b300 -e0 | IF ERRORLEVEL 100 GOTO START | IF ERRORLEVEL 10 GOTO CBV | IF ERRORLEVEL 5 GOTO NET/ECHO | IF ERRORLEVEL 4 GOTO ECHOMAIL | IF ERRORLEVEL 3 GOTO NETMAIL | GOTO START | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 215 | :LOCAL | F: | CD\SBBS | BBS -l -e0 | IF ERRORLEVEL 100 GOTO START | IF ERRORLEVEL 24 GOTO BID | IF ERRORLEVEL 10 GOTO CBV | IF ERRORLEVEL 5 GOTO NET/ECHO | IF ERRORLEVEL 4 GOTO ECHOMAIL | IF ERRORLEVEL 3 GOTO NETMAIL | IF ERRORLEVEL 2 GOTO START | GOTO START | | :RETURN | F: | CD\SBBS | BBS -r -e0 | IF ERRORLEVEL 100 GOTO START | IF ERRORLEVEL 24 GOTO BID | IF ERRORLEVEL 10 GOTO CBV | IF ERRORLEVEL 5 GOTO NET/ECHO | IF ERRORLEVEL 4 GOTO ECHOMAIL | IF ERRORLEVEL 3 GOTO NETMAIL | GOTO START | | :CBV | F: | CD\SBBS\CBV | RADDS | GOTO RETURN | | :FAX | F: | CD\COMMO\FAX | NETFAXREC COM4 | IF ERRORLEVEL 1 GOTO RECFAX | GOTO RETURN | | :RECFAX | CD\SBBS | SUTIL POST 2 RECFAX.TXT SYSOP NETFAX FAX | GOTO RETURN | | :BID | F: | CD\SBBS\BID | BID | GOTO RETURN | | :NET/ECHO | GOTO NETMAIL | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 216 | :ECHOMAIL | GOTO RETURN | | :NETMAIL | F: | CD\DB\DBUTL | dir >nul | MBUTIL EXPORT | GOTO START | | :MAIL | F: | CD\DB\DBUTL | MBUTIL EXPORT -RETEAR | GOTO START | | :UNPACK | F: | CD\DB\DBUTL | MBUTIL IMPORT | MBUTIL SORT -PACK | MBUTIL LINK -CLEAN | GOTO START | | :CLEAN | F: | CD\DB\DBUTL | MBUTIL PURGE -FILE PURGE.MBU | MBUTIL PACK -FORCE -DELETE -RECOVER | GOTO START | | :IMPORT | F: | CD\DB\DBUTL | MBUTIL IMPORT F:\DB\MESSAGES\DBSOFT DB_SOFT -DELETE | MBUTIL IMPORT F:\DB\MESSAGES\DBTECH DB_TECH -DELETE | GOTO START | | :UNFRAG | CALL F:\DB\FRESH | GOTO START | | :BKUP-C-D-E | C: | CD\TOOLS\CP7 | CPBACKUP FULL-C-D-E | GOTO START | | :BKUP-F | C: | CD\TOOLS\CP7 | CPBACKUP FULL-F | GOTO START -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 217 | :BKUPMSG | C: | CD\TOOLS\CP7 | CPBACKUP MSGBASE | GOTO START | | :WKLYMNT | F: | CD\SBBS | SUTIL AUTO BBSWKLY.CTL | GOTO START | | :CRIT | F: | CD\CRIT | IF EXIST USERS.BK1 DEL USERS.BK1 | IF EXIST SUSERS.BK1 DEL SUSERS.BK1 | IF EXIST USERS.BBS REN USERS.BBS USERS.BK1 | IF EXIST SUSERS.BBS REN SUSERS.BBS SUSERS.BK1 | COPY F:\SBBS\USERS.BBS | COPY F:\SBBS\SUSERS.BBS | | rem COPY F:\SBBS\*.BBS A:\ | rem COPY F:\DB\DBRIDGE.AUT A:\ | rem COPY F:\DB\DBRIDGE.CFG A:\ | | cd\db\dbutl | mbutil pack -force -delete -recover | | CD\SBBS | STOP TOP10 U15 D15 C15 M15 I | USERPACK | USERSORT SEC- LAST+ FIRST+ | SUTIL AUTO F:\SBBS\BBSMAINT.CTL >f:\logs\sutil.log | | CD\SBBS\SBLU | COPY F:\SBBS\STXT\NEWS.ANS | COPY D:\FILES\DOWN\ETCFILES.NEW NEWFILES.DAT | | F: | CD\LOGS | DBTRIM 14 DBRIDGE.LOG | | D: | CD\FILES\DOWN | PKZIP ETCFILES.ZIP ETCFILES.TXT | | F: | IF EXIST F:\DB\FILES\*.* GOTO NEWFILES | GOTO START -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 218 | :NEWFILES | F: | CD\DB\FILES | IF NOT EXIST N387LIST.* GOTO NDIFF | COPY N387LIST.* F:\DB\NODELIST | DEL N387LIST.* | | :NDIFF | F: | CD\DB\FILES | IF NOT EXIST NODEDIFF.* GOTO NPN | COPY NODEDIFF.* F:\DB\NODELIST | DEL NODEDIFF.* | | :NPN | F: | CD\DB\FILES | IF NOT EXIST NPNBULL.ZIP GOTO NPNLIST | COPY NPNBULL.ZIP F:\SBBS\WORK | CD\SBBS\WORK | PKUNZIP NPNBULL.ZIP | TYPE UPDATE.TXT >>D:\FILES\FNPN\UPDATE.TXT | DEL UPDATE.TXT | COPY *.ZIP D:\FILES\FNPN | DEL *.ZIP | CD\DB\FILES | | :NPNLIST | F: | CD\DB\FILES | IF NOT EXIST NPNLIST.* GOTO ALAMO | COPY NPNLIST.* F:\DB\NODELIST | DEL NPNLIST.* | | :ALAMO | F: | CD\DB\FILES | IF NOT EXIST 1836LIST.* GOTO NAC-NET | COPY 1836LIST.* F:\DB\NODELIST | DEL 1836LIST.* | | :NAC-NET | F: | CD\DB\FILES | IF NOT EXIST NAC-NET.* GOTO AFILES | COPY NAC-NET.* F:\DB\NODELIST | DEL NAC-NET.* | -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 219 | :AFILES | F: | CD\DB\FILES | IF NOT EXIST ALAMO*.* GOTO TICK | COPY ALAMO*.* D:\FILES\ALAMO | DEL ALAMO*.* | | :TICK | F: | CD\DB\FILES | IF NOT EXIST *.TIC GOTO FLEA | CD\DB\DBUTL | TICK >>F:\LOGS\TIC.LOG | | :FLEA | F: | CD\DB\FILES | IF NOT EXIST *.FLE GOTO BBSLIST | CD\DB\UTIL | TICK >>F:\LOGS\TIC.LOG | | :BBSLIST | F: | CD\DB\FILES | IF NOT EXIST BBSLST.ZIP GOTO QWK | COPY BBSLST.ZIP D:\FILES\DOWN | PKUNZIP BBSLST.ZIP | COPY BBSLST.SCR F:\SBBS\STXT\BULLET2.ANS | COPY BBSLST.BBS F:\SBBS\STXT\BULLET2.ASC | DEL BBSLST.* | | :QWK | F: | CD\DB\FILES | IF NOT EXIST *.QWK GOTO ECHOSTAT | COPY *.QWK F:\BLUE\DOWN | DEL *.QWK | | :ECHOSTAT | F: | CD\DB\FILES | IF NOT EXIST SS_AREAS.ARC GOTO SCAN | COPY SS_AREAS.* E:\FILES\SYSO | DEL SS_AREAS.* | | :SCAN | SCAN F:\DB\FILES /A /D /NOPAUSE /REPORT F:\LOGS\VIRUS.TMP IF | ERRORLEVEL 2 GOTO START | IF ERRORLEVEL 1 TYPE F:\LOGS\VIRUS.TMP >>F:\LOGS\DBRIDGE.LOG | DIR /A-D /ON F:\DB\FILES >>F:\LOGS\VIRUS.LOG | TYPE F:\LOGS\VIRUS.TMP >>F:\LOGS\VIRUS.LOG | CD\DB\FILES -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 220 | COPY *.* F:\FILES | ECHO Y | DEL *.* | GOTO START | | :RESET | E: | CD\SBBS | IF EXIST ERRORS.LOG TYPE ERRORS.LOG >PRN | IF EXIST ERRORS.BBS TYPE ERRORS.BBS >PRN | IF EXIST ERRORS.BBS GOTO END | WAIT 1 | ECHO ATZ >COM4 | WAIT 1 | CLS | BOOT | | :END | CLS | ECHO --------------------------------------------------------- | ECHO --------------------------------------------------------- | ECHO ** FATAL ERROR: THE MEDNET IS DOWN... NOTIFY BOB ASAP ** | ECHO --------------------------------------------------------- | ECHO --------------------------------------------------------- | | Information by Bob Jackson, | ETC MedNet, | 1:387/801 Fidonet, | San Antonio, Texas | | Hope that these examples have been of any use. Let me know if | you want more information on how to run a SuperBBS system. | | Multiline setup examples are not available. If you have a | multiline setup, let me have the example to setup a system and | your info will be used in the 1.18 documentation. 14.2 Equipment -------------------------------------------------------------- SuperBBS has been tested with a wide variety of machines, ranging from a simple XT to a 80486-33 Mhz, and software, including MS-Dos 5.0, JP Software 4DOS 4.00 and Desqview. If you have any trouble running a certain combination of hardware and/or software, contact the support nodes. They might be able to help, or give you information on how to obtain help. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 221 14.3 Turbo Pascal/Run time errors -------------------------------------------------------------- SuperBBS is written in Turbo Pascal. Here are some Turbo Pascal errors. If you receive a message like: Runtime error: ???? It means an error occurred. The following list might help you to discover what went wrong. Code.........: 2 Description..: File not found Solution.....: You've deleted a SuperBBS file and SuperBBS can't find it. Check which file is possibly missing and replace it. Code.........: 3 Description..: Path not found Solution.....: You've configured a non existing path in the configuration. Check your setup. Code.........: 4 Description..: Too many open files Solution.....: MsDos 'Files=??' statement in config.sys is too low, increase the value. You will need to re- boot your computer. Code.........: 5 Description..: File access denied Solution.....: You've used a Hidden/ReadOnly attribute with a SuperBBS file. Don't do that! Code.........: 15 Description..: Invalid drive number Solution.....: You've configured an illegal drive in the con- figuration. Code.........: 100 Description..: Disk read error Solution.....: Your hard disk has problems, check it. Code.........: 103 Description..: File not open Solution.....: Problems with open/close/read files, try to increase 'Files=??' statement first. Code.........: 150 Description..: Disk write protected Solution.....: You've a write protected disk, don't do that. -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 222 Code.........: 151 Description..: Unknown unit Solution.....: You've configured an illegal unit/drive in the configuration. Code.........: 152 Description..: Drive not ready Solution.....: Problems with your disk drive, check it. Code.........: 156 Description..: Disk seek error Solution.....: Problems with your disk drive, check it. Code.........: 157 Description..: Unknown media type Solution.....: Operating system doesn't recognize your disk drive's format. Check it. Code.........: 158 Description..: Sector not found Solution.....: Problems with your disk drive, check it. Code.........: 162 Description..: Hardware failure Solution.....: Problems with your hardware, check it. Code.........: 200 Description..: Division by zero Solution.....: Program error, inform authors. Code.........: 202 Description..: Stack overflow error Solution.....: Program error, inform authors. | Errors not mentioned here can also be experienced, but they | are not normal. You will also get an error above 202 when your | .SCC file is not found or valid. That's it. For more information about these errors, refer to the Turbo Pascal manuals, or contact the nearest SuperBBS help support. 14.4 Credits -------------------------------------------------------------- All names and programs mentioned in this documentation are copyrighted by their owners. Please observe the rules to use these programs and register them if needed. Shareware can't live without your support. Do not use illegally obtained soft- ware. Nobody mentioned, nobody forgotten. We thank every writer of software available to SuperBBS for his/her contribution. Keep up the good work! -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 223 Chapter 15 SuperNet ============================================================== SuperNet is an elite network joining SuperBBS bulletin board systems all over the world. It is a direct connection to the SuperBBS group, documentation writer and users alike to dis- cuss SuperBBS operations and development, watch for program and utilities updates or just a place to chat about SuperBBS. SuperNet will make a nice addition to your local SuperBBS bulletin board system. Currently SuperNet is available in the following countries: - Finland - Sweden - Denmark - Norway - USA - Canada - Germany - The Netherlands - Japan - Taiwan - Switzerland - China - Australia - and more..... For more information concerning SuperNet, contact the Support boards of SuperBBS. Most systems are connected to SuperNet. SuperNet nodes are using the 42:xxxx/xxxx node numbers. The Northern America sites are using net 43 for their nodenumbers. Net 44 is used for the BBS nodes in Japan and Taiwan. Net 45 is used in Australia. Most SuperNet systems have the nodelist available for down- load. Ask a SuperBBS Support site for one, if you can't find a nodelist from SuperNet near you. There are several echomail areas available in SuperNet. Most of these areas are available to all users and Sysops of the Bulletin Board System. Here's a short overview: Area.........: SBBS_INT Description..: SuperNet echomail about all kinds of subjects, not necessarily about SuperBBS. Available to.: Sysops and users -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 224 Area.........: Superthoughts Description..: SuperNet echomail for chit chat. Subject is free. (Except for personal attacks and commer- cials). Available to.: Sysops and users Area.........: SBBS_BUGS Description..: SuperNet echomail for reporting bugs in Super- BBS. Replies can be given as long they concern the subject. Available to.: Sysops (write access) Area.........: SBBS_TIPS Description..: SuperNet echomail for tips and hints about SuperBBS. Replies can be given as long they concern the subject. Available to.: Sysops (write access) Area.........: SNET_INT Description..: SuperNet READ ONLY echomail area with news from the SuperNet coordinators and the SuperBBS team. Available to.: Sysops (READ ONLY) More areas are available, this is only a small sample of the current areas. Most countries have their own national echomail areas available. Join an elite network, join SuperNet! -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 225 Appendix A Menu list ============================================================== Menu Description Page ------ ---------------------------------------------- ------ 0 Text line 108 1 Goto new menu 109 2 Gosub new menu 109 3 Return from last gosub 109 4 Goto new menu and clear gosub stack 110 5 Display .ANS/.ASC file 110 6 Selection menu 110 7 Shell to dos 111 8 Version and copyright notice 112 9 Logoff from system 112 10 Display system usage graph 113 11 Page the Sysop 113 12 Execute questionnaire 113 13 List/search userlist 113 14 Time statistics 113 15 Exit to DOS with errorlevel 114 16 Change city and state 114 17 Change password 114 18 Change screenlength 114 19 Toggle screen clearing 114 20 Toggle more prompt 114 21 Toggle ANSI graphics 114 22 Scan for personal mail 115 23 Read messages 115 24 Scan messages 115 25 Quick scan messages 115 26 Delete messages 116 27 Write messages 116 28 Select combined message areas 116 29 Move a file 117 30 MS-Dos directory list 117 31 List FILES.BBS 117 32 Download file 117 33 Upload file 118 34 View archived file 118 35 Search for file by keyword 118 36 Search for file by filename 118 37 List new files on system 118 38 Type a textfile 119 39 Display a textfile 119 40 Display .ANS/.ASC file with Hotkey enabled 119 41 Toggle fullscreen editor 119 45 Display .ANS/.ASC file with 'Press ENTER' 120 46 Show GIF resolution 120 47 Write entry in system logfile 120 48 Download specific file 120 53 Toggle mailcheck at logon 121 54 Toggle newfiles check at logon 121 -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 226 55 Show BBS list (Short) 121 56 Add BBS to BBS list 121 57 Leave comment for next user 121 58 Show callers 121 59 Change colour configuration 122 60 Extract files 122 61 Archive files 122 62 Delete files 122 63 Show BBS list (Long) 123 64 Change BBS information in BBS list 123 65 Delete BBS information in BBS list 123 66 Download BBS list 123 67 Change user's phonenumber(s) 123 68 Select message area from list 123 69 Select/Pick file area from list 124 70 Change alias 124 71 List aliases 125 72 Show user's balance in timebank 125 73 Deposit time in timebank 125 74 Withdraw time from timebank 125 75 User online 125 76 Send message to other line 125 77 Change current language 125 78 Toggle 'Do not disturb' flag 126 79 Toggle fullscreen message viewer 126 80 Display areas with unread mail 126 81 Perform viruscheck 126 82 Download QWK packet 126 83 Upload QWK reply packet 126 84 Toggle lastread pointer 127 85 Show random aphorism 127 86 Run a door 127 87 Choose a door 128 88 Browse the nodelist 128 89 Area by area read command 128 90 Send local file attach 128 91 Local file attach check 129 92 Change packer for QWK 129 93 Download ANY file 129 94 Display user age graph 129 95 Remove or show flagged files 129 96 Use combined boards for mail check 130 97 Select default protocol 130 98 Toggle hotkeys 130 99 Node chat 130 100 Create/remove node chat conference 130 101 Leave/remove message comment 130 -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 227 Appendix B Bugreport and Suggestion form ============================================================== Suggestions form. Send this to the SuperBBS HQ in Finland. Date..................: ... - ... - 19 ... Name..................: ____________________________________ Address...............: ____________________________________ ____________________________________ ____________________________________ BBS name..............: ____________________________________ BBS telephone nr......: ____________________________________ My suggestion is : ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 228 Bugreport form. Send this to the SuperBBS HQ in Finland. Date..................: ... - ... - 19 ... Name..................: ____________________________________ Address...............: ____________________________________ ____________________________________ ____________________________________ BBS name..............: ____________________________________ BBS telephone nr......: ____________________________________ The bug found is : (Please be as clearly as possible) ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ ______________________________________________________________ -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 229 That's all folks! See you around for version 1.18 The author: Frank Hemmelder -------------------------------------------------------------- SuperBBS v1.17 Documentation Page 230